Documentation page
From WikIRI
back to main page of the robotics lab
Contents |
Template
The main.dox template for the documentation can be found in these links or in the IRI new development project template file.
wget http://www.iri.upc.edu/people/mmorta/template_doc/main-template-r0.dox
ROS Template
Download the mainpage.dox and replace the one in your package. Fill the contents.
Generation
The documentation is generated online everyday with the last changes of the repository in this website:
In local you can generate the documentation using
make doc
or to generate a project documentation using the IRI style you have to follow these instructions
cd doc svn checkout https://devel.iri.upc.edu/labrobotica/tools/iri_doc cd ../build; rm -rf *; cmake ..; make; make doc
ROS Generation
You need the ros-__version__-documentation package, then If it is installed in /opt/ as usual, just write the following command:
/opt/ros/electric/stacks/documentation/rosdoc/rosdoc -o ~/desired_folder name_of_package
Writing
API documentation (Header)
Header files include the api documentation (class, methods and attributes)
Classes are documented using:
/*!
\class CName
\brief description
*/
class CName {};
Structs
/*!
\struct Name
\brief description
*/
typedef struct{} Name;
Attributes
type name; //!< description
Methods
/*!
\brief short description
still short description
long description
\param var_in description
\retval var_out description
\return what is returned
*/
type CName::method(const type & var_in, type & var_out){}
Example sources should have a little introduction and a how to use the program
/*! \example example.cpp \brief short description long description how to */
Other documentation
For the instructions and other stuff there's a file called main.dox which contains all of these other documentation. It has the following structure:
Mainpage Image it may contains an image of the device stored in the folder /doc/images
Summary a little summary of the library with an explanation of what is it for and the main features
Contents: items can be added for other contents not listed External documentation: links to datasheets, wikIRI pages, manufacturer page or other pages of interest License and Disclaimer
Pages Their structure is Name, pages menu and contents of the page.
TODO
Put the project name at the top of the documentation
