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

How to document ROS2 C++ package source code?

asked 2018-08-19 13:40:55 -0600

thinwybk gravatar image

updated 2018-08-20 02:57:36 -0600

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.)

edit retag flag offensive close merge delete


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.

William gravatar image William  ( 2018-08-21 10:27:08 -0600 )edit

1 Answer

Sort by ยป oldest newest most voted

answered 2018-08-20 20:00:51 -0600

Geoff gravatar image

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.

edit flag offensive delete link more


The main thing I am interested in is integrating nicely with the future ROS2 API build infrastructure which will generate (not existing yet).

thinwybk gravatar image thinwybk  ( 2018-08-21 01:47:01 -0600 )edit

If you are looking to be compatible with something that does not exist yet, then I don't think there's any answer that will help you. I suggest you use what you've already found, since they are common tools, and update when necessary.

Geoff gravatar image Geoff  ( 2018-08-21 16:39:37 -0600 )edit

Usually some people have already something in mind which is not public yet. I just tried to get this Info already. As you said sticking to something common and migrating if necessary is a good idea.

thinwybk gravatar image thinwybk  ( 2018-08-22 01:46:20 -0600 )edit

Question Tools



Asked: 2018-08-19 13:40:55 -0600

Seen: 469 times

Last updated: Aug 20 '18