ROS Resources: Documentation | Support | Discussion Forum | Index | Service Status | ros @ Robotics Stack Exchange
Ask Your Question

How to introduce the doxygen PREDEFINED tag in rosdoc_lite

asked 2014-04-17 22:57:28 -0600

Fabien Spindler gravatar image

I wanted that the following class protected by an #ifdef appears in the generated class list:

class myClass {

With doxygen this could be achieved by putting PREDEFINED="HAVE_MY_LIBRARY" in the config file.

I haven't see how to do the same with rosdoc_lite ?

Regards Fabien

edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted

answered 2014-04-18 05:53:18 -0600

joq gravatar image

updated 2014-04-30 04:19:05 -0600

The rosdoc_lite script does not attempt to provide all the features of every documentation builder. It merely provides a useful subset that can be run automatically on the ROS build farm.

The usual recommendation for those with complex documentation schemes is to use Doxygen (or Sphinx or Epydoc) directly, generating the docs yourself.

The Doxygen builder does provide a set of tags that you can modify. I don't see PREDEFINED in that list, but perhaps it could be added.

If you want to try doing that, please open an enhancement issue with a link to this question, and provide a pull request, if possible.

Update: Fabien provided his requested enhancement. It is now released to Groovy, Hydro and Indigo. See: ros-infrastructure/rosdoc_lite#47.

Thanks for contributing!

edit flag offensive delete link more

Question Tools


Asked: 2014-04-17 22:57:28 -0600

Seen: 308 times

Last updated: Apr 30 '14