| ROS Resources: Documentation | Support | Discussion Forum | Index | Service Status | ros @ Robotics Stack Exchange |
What's the current best practice to document ROS2 (Bouncy, colcon build) C++ package source code? (According to ros2doc templates it seems like the sphinx extension breathe is used to post process doxygen generated docs.)
There is not yet any defined best practice on documenting ROS2 packages. The ROS2 style guide does give some information on what should be in the documentation, but it does not prescribe a format. Use what you are familiar with, what is easy to maintain, and what produces good, readable documentation.
The main thing I am interested in is integrating nicely with the future ROS2 API build infrastructure which will generate http://docs.ros2.org/api/ (not existing yet).
Asked: 2018-08-19 13:40:55 -0600
Seen: 525 times
Last updated: Aug 20 '18
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.
That's still the plan I think. For now, I'd just use doxygen with c++ and if you want create a doxygen file in your project so it can generate documents you can do that, but what's in it may need to change in the future.