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

Manually modify Code API pages?

asked 2013-02-05 11:47:05 -0600

130s gravatar image

updated 2014-01-28 17:15:07 -0600

ngrennan gravatar image

I thought that there would be cases where sharing internal design docs (UML diagrams etc.) is beneficial to the future developers (or even to users?). But wiki pages ($TOOL_HOME$) might be better saved for how-to-use explanation rather than internal implementation description. Code API pages ($TOOL_HOME$/html) seem perfect place, but is there a way to manually update API pages (via web browser like wiki)? I've seen this thread that says API pages are autogenerated from code documents but haven't found anything that answers my question. Being able to modify the page layout helps particularlly when I want to paste images.

edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted

answered 2013-04-17 22:09:30 -0600

tfoote gravatar image

updated 2013-04-17 22:19:23 -0600

The API documentation comes from doxygen, sphinx or epydoc inside each package. See the rosdoc_lite documentation for how to enable each of these documentation methods. The default is mainpage.dox which is generated by ros_create_pkg.

edit flag offensive delete link more

Question Tools


Asked: 2013-02-05 11:47:05 -0600

Seen: 146 times

Last updated: Apr 17 '13