ecl_doc Documentation

ecl_doc: Documentation generator for the ecl

Generates documentation and graphs for the ecl - powered by rosdoc under the hood.

• Homepage: http://ros.org/wiki/ecl_doc

packageSummary

Documentation generator for the ecl. A default run of this package will generate the doxygen/python documentation as well as some graphs showing interdependencies for all packages in the ecl. It will additionally upload the results to the ecl server (currently disabled).

It uses rosdoc under the hood to power the documentation generation.

Usage

Generate Stack Documentation

To make the html documentation as well as ecl graphs do the following:

roscd ecl_doc
make

This generates htmls and pdf's in ecl_doc's doc folder. Important files:

• ecl_doc/doc/index.html : html documentation front page.
• doc/ecl_package_graph.pdf : ecl stack graphs.

Generate Package Documentation

To check on the package documentation for a single package, simply run

rosrun rosdoc rosdoc -o doc <package_name>