scoutos / scout / bom / mainpage.dox @ 738e44fb
History | View | Annotate | Download (965 Bytes)
1 |
/** |
---|---|
2 |
\mainpage |
3 |
\htmlinclude manifest.html |
4 |
|
5 |
\b bom is the ros node that will orient the robots toward each other and tell the direction that any sources of IR are coming from. It can also provide information relating to the orientation of the other robot and which robot it is. |
6 |
|
7 |
<!-- |
8 |
Bom will contain the functions necessary for reading the values obtained by the bearing and orientation module. It will also provide commands for asking the module to get readings from specific robots. |
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 |
*/ |