root / scout / scoutsim / mainpage.dox @ 5d1c5d81
History | View | Annotate | Download (933 Bytes)
1 | 266ae7f2 | Alex Zirbel | /** |
---|---|---|---|
2 | \mainpage |
||
3 | \htmlinclude manifest.html |
||
4 | |||
5 | \b scoutsim runs a simulator of the Scout robot for faster development. |
||
6 | |||
7 | <!-- |
||
8 | In addition to providing an overview of your package, |
||
9 | this is the section where the specification and design/architecture |
||
10 | should be detailed. While the original specification may be done on the |
||
11 | wiki, it should be transferred here once your package starts to take shape. |
||
12 | You can then link to this documentation page from the Wiki. |
||
13 | --> |
||
14 | |||
15 | |||
16 | \section codeapi Code API |
||
17 | |||
18 | <!-- |
||
19 | Provide links to specific auto-generated API documentation within your |
||
20 | package that is of particular interest to a reader. Doxygen will |
||
21 | document pretty much every part of your code, so do your best here to |
||
22 | point the reader to the actual API. |
||
23 | |||
24 | If your codebase is fairly large or has different sets of APIs, you |
||
25 | should use the doxygen 'group' tag to keep these APIs together. For |
||
26 | example, the roscpp documentation has 'libros' group. |
||
27 | --> |
||
28 | |||
29 | |||
30 | */ |