eitanme
commented
11 years ago Finally got around to adding this. Documentation is now generated for actions and added to the index.
Relevant commits:
Fuerte: https://github.com/ros-infrastructure/rosdoc_lite/commit/50f735fc7b74a31c0c630798229ccd2faf90ef64 Groovy: https://github.com/ros-infrastructure/rosdoc_lite/commit/86e564ea7f4add73665bd77bbb310bbcdd84404a
Example of docs:
Index: http://ros.org/doc/groovy/api/move_base_msgs/html/index-msg.html Action: http://ros.org/doc/groovy/api/move_base_msgs/html/action/MoveBase.html
Issue migrated from code.ros.org reported by "eitan", Ticket #2435
https://code.ros.org/trac/ros/ticket/2435
Description
Right now there is no support for auto-generated documentation of .action files or their generated .msg files. At some point, we should modify rosdoc to handle them correctly.
Change History
Changed 3 years ago by kwc
owner changed from kwc to eitan I'm going to assign back to you. I think it should be possible to adapt the existing rosdoc codebase to do this, but I leave it up to the actionlib authors to make this a reality (at least until my plate clears more)
Changed 18 months ago by gerkey
cc gjones, matei, hsaio added priority changed from minor to major This came up today in the arm_navigation review, where we found some auto-generated action .msg files checked into source control, at least in part because documentation is not being created for the underlying .action files.
Eitan, could you have a look at it?
Changed 18 months ago by eitan
status changed from new to assigned Looking into it, I've been looking for an opportunity to dig into the internals of rosdoc anyways... should be fun.
Changed 18 months ago by eitan
So, there's going to be a little bit of work involved in adding this feature that I'll try to get to over the next couple of days. However, in the meantime, you shouldn't have to check auto-generated messages in to have documentation generated for them. Instead, you should add a rosdoc.yaml file to the package that specifies the package should be built before documentation is generated. This is documented in detail here, http://www.ros.org/wiki/rosdoc#Enabling_via_manifest.xml, and should hold you guys over until I get the full feature in.
Changed 18 months ago by kwc
the rosdoc.yaml approach probably won't work b/c the indexer uses trunk of every stack. I've been meaning to investigate whether or not rosdoc can start using the debs instead for 'stable' stacks. That might help.
I can also help you delve through the rosdoc code. Some of it has been refactored, but the message doc stuff is at the heart of the bad bits.