Ask Your Question
2

Documenting parameters and nodes

asked 2012-10-18 04:33:13 -0500

Is there any standard way to generate documentation for nodes and parameters in a ros wiki like form?

I tried with rosdoc but I'm getting only the doxygen documentation.

edit retag flag offensive close merge delete

Comments

Actually a little step has been made with http://ros.org/wiki/rosdoc_lite.. still not enough..

Francesco Sacchi gravatar image Francesco Sacchi  ( 2012-10-24 22:54:57 -0500 )edit

1 Answer

Sort by ยป oldest newest most voted
4

answered 2012-10-18 05:14:12 -0500

jbohren gravatar image

updated 2012-10-18 05:17:58 -0500

Unfortunately, there's no automatic way of doing this at the moment.

That being said, it'd be great to have a standard (like XML or YAML-based) way of documenting a node's ROS interface. Then a file like that could be parsed by the wiki.

edit flag offensive delete link more

Comments

Probably some documentation should be easy to generate.. the list of nodes can be taken from the CMakeLists.txt file, and for simple nodes also the list of topics can be extracted with some greps... harder if the topic subscription/publication is done not in the main function..

Francesco Sacchi gravatar image Francesco Sacchi  ( 2012-10-24 22:57:37 -0500 )edit

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Question Tools

Stats

Asked: 2012-10-18 04:33:13 -0500

Seen: 269 times

Last updated: Oct 18 '12