Gazebo | Ignition | Community
Ask Your Question

Gazebo plugin sdf configuration tags proper documentation

asked 2013-11-12 23:24:04 -0500

silvio.traversaro gravatar image

Hi, I was documenting some Gazebo plugins and I was adding information about how to configure them (using the child sdf tags of the <plugin> element) in the doxygen plugin class documentation, but I don't know if it is the right place. I was then wondering if there is a standard/guideline for proper documenting the child sdf tags that a Gazebo plugin accepts for configuration.

edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted

answered 2013-11-13 15:32:14 -0500

nkoenig gravatar image

We haven't defined a standard for documenting plugins, but we should. Here is an issue to track this.

For now, you can put plugin documentation in the plugin's header file.

edit flag offensive delete link more

Question Tools


Asked: 2013-11-12 23:24:04 -0500

Seen: 277 times

Last updated: Nov 13 '13