root / scout / cliffsensor / mainpage.dox @ a826ac0f
History | View | Annotate | Download (805 Bytes)
1 | 04f50f8a | Priya | /** |
---|---|---|---|
2 | \mainpage |
||
3 | \htmlinclude manifest.html |
||
4 | |||
5 | \b cliffsensor is the ros node that will read from the cliffsensors and detect cliffs and tell the motors to stop driving. |
||
6 | |||
7 | <!-- |
||
8 | Cliffsensor will contain the functions necessary for reading from the cliffsensors and detecting cliffs (and behaviors associated with the cliffsensor). |
||
9 | --> |
||
10 | |||
11 | |||
12 | \section codeapi Code API |
||
13 | |||
14 | <!-- |
||
15 | Provide links to specific auto-generated API documentation within your |
||
16 | package that is of particular interest to a reader. Doxygen will |
||
17 | document pretty much every part of your code, so do your best here to |
||
18 | point the reader to the actual API. |
||
19 | |||
20 | If your codebase is fairly large or has different sets of APIs, you |
||
21 | should use the doxygen 'group' tag to keep these APIs together. For |
||
22 | example, the roscpp documentation has 'libros' group. |
||
23 | --> |
||
24 | |||
25 | |||
26 | */ |