Attention: Answers.ros.org is deprecated as of August the 11th, 2023. Please visit robotics.stackexchange.com to ask a new question. This site will remain online in read-only mode during the transition and into the foreseeable future. Selected questions and answers have been migrated, and redirects have been put in place to direct users to the corresponding questions on Robotics Stack Exchange. Additional details are available here.

Documenting parameters and nodes

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

Francesco Sacchi
203 ●5 ●9 ●14 http://blog.mindengine.it/

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 ( 2012-10-24 22:54:57 -0500 )edit

add a comment

1 Answer

Sort by » oldest newest most voted

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

jbohren

5799 ●55 ●87 ●102 http://dscl.lcsr.jhu.e...

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

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 ( 2012-10-24 22:57:37 -0500 )edit

add a comment

Question Tools

Stats

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

Seen: 402 times

Last updated: Oct 18 '12

Documenting parameters and nodes edit

Comments

1 Answer

Comments

Question Tools

Stats

Related questions

Documenting parameters and nodes