| ROS Resources: Documentation | Support | Discussion Forum | Index | Service Status | ros @ Robotics Stack Exchange |
I wanted that the following class protected by an #ifdef appears in the generated class list:
#ifdef HAVE_MY_LIBRARY
class myClass {
public;
myClass(){};
};
#endif
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
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!
Asked: 2014-04-17 22:57:28 -0500
Seen: 316 times
Last updated: Apr 30 '14
ROS Answers is licensed under Creative Commons Attribution 3.0 Content on this site is licensed under a Creative Commons Attribution Share Alike 3.0 license.
