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

rosdoc_lite and raw messages in generated documentaion

asked 2013-03-04 21:45:59 -0500

TommyP gravatar image

updated 2013-07-28 01:17:54 -0500

According to

in the comments field

"Good point. I've put support for raw messages back in. This should fix up all the documentation the next time all the doc jobs run."

I have now tested the latest rosdoc_lite (latest Ubuntu packages) for private documentation and this does not work for me. And I cannot find any flag to rosdoc_lite to enable this. So how should I start rosdoc_lite to get the raw messages included in the generated documentation?

This all worked in rosdoc.

Adding more information_

Running by using target:

add_custom_target (lrs_msgs_doc 
  rosdoc_lite -o ${CATKIN_DEVEL_PREFIX}/doc/lrs_msgs ${CATKIN_DEVEL_PREFIX}/../src/lrs_msgs

The when running get the folloing output:

tompe@tpdell:~/lrs_ws$ catkin_make lrs_msgs_doc
Base path: /home/tompe/lrs_ws
Source space: /home/tompe/lrs_ws/src
Build space: /home/tompe/lrs_ws/build
Devel space: /home/tompe/lrs_ws/devel
Install space: /home/tompe/lrs_ws/install
#### Running command: "make cmake_check_build_system" in "/home/tompe/lrs_ws/build"
#### Running command: "make lrs_msgs_doc -j8 -l8" in "/home/tompe/lrs_ws/build"
Documenting a catkin package
Documenting lrs_msgs located here: /home/tompe/lrs_ws/src/lrs_msgs
{'doxygen': {'builder': 'doxygen', 'output_dir': '.'}}
{'builder': 'doxygen', 'output_dir': '.'}
Generated the following tagfile string 
doxygen-ating lrs_msgs [doxygen /tmp/tmpsZf1og]
warning: tag INCLUDE_PATH: include path `$INCLUDE_PATH' does not exist
warning: source $INCLUDE_PATH is not a readable file or directory... skipping.
[('VisFrustrum', '/home/tompe/lrs_ws/src/lrs_msgs/msg/VisFrustrum.msg'), ('GeoPoint', '/home/tompe/lrs_ws/src/lrs_msgs/msg/GeoPoint.msg'), ('Sticks', '/home/tompe/lrs_ws/src/lrs_msgs/msg/Sticks.msg'), ('MPParams', '/home/tompe/lrs_ws/src/lrs_msgs/msg/MPParams.msg'), ('PtuExtData', '/home/tompe/lrs_ws/src/lrs_msgs/msg/PtuExtData.msg'), ('TFPOPProblem', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TFPOPProblem.msg'), ('PMAVInfo', '/home/tompe/lrs_ws/src/lrs_msgs/msg/PMAVInfo.msg'), ('LQQueueInfo', '/home/tompe/lrs_ws/src/lrs_msgs/msg/LQQueueInfo.msg'), ('TFPOPAnswer', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TFPOPAnswer.msg'), ('PlatformParams', '/home/tompe/lrs_ws/src/lrs_msgs/msg/PlatformParams.msg'), ('SticksValue', '/home/tompe/lrs_ws/src/lrs_msgs/msg/SticksValue.msg'), ('QuadState', '/home/tompe/lrs_ws/src/lrs_msgs/msg/QuadState.msg'), ('LQClimbCommand', '/home/tompe/lrs_ws/src/lrs_msgs/msg/LQClimbCommand.msg'), ('ThreeDObject', '/home/tompe/lrs_ws/src/lrs_msgs/msg/ThreeDObject.msg'), ('TSTNodeStatus', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TSTNodeStatus.msg'), ('LQStatus', '/home/tompe/lrs_ws/src/lrs_msgs/msg/LQStatus.msg'), ('MPRefinements', '/home/tompe/lrs_ws/src/lrs_msgs/msg/MPRefinements.msg'), ('LQPtuCommand', '/home/tompe/lrs_ws/src/lrs_msgs/msg/LQPtuCommand.msg'), ('TFPOPPlan', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TFPOPPlan.msg'), ('LQQueueCommands', '/home/tompe/lrs_ws/src/lrs_msgs/msg/LQQueueCommands.msg'), ('LQFlyCommand', '/home/tompe/lrs_ws/src/lrs_msgs/msg/LQFlyCommand.msg'), ('TFPOPRequest', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TFPOPRequest.msg'), ('TFPOPThread', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TFPOPThread.msg'), ('TSTInfo', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TSTInfo.msg'), ('OMPLInfo', '/home/tompe/lrs_ws/src/lrs_msgs/msg/OMPLInfo.msg'), ('RMAXStatus', '/home/tompe/lrs_ws/src/lrs_msgs/msg/RMAXStatus.msg'), ('Point', '/home/tompe/lrs_ws/src/lrs_msgs/msg/Point.msg'), ('ExtData', '/home/tompe/lrs_ws/src/lrs_msgs/msg/ExtData.msg'), ('VisDelete', '/home/tompe/lrs_ws/src/lrs_msgs/msg/VisDelete.msg'), ('MPRoadmap', '/home/tompe/lrs_ws/src/lrs_msgs/msg/MPRoadmap.msg'), ('HeliState', '/home/tompe/lrs_ws/src/lrs_msgs/msg/HeliState.msg'), ('TSTNodeInfo', '/home ...
edit retag flag offensive close merge delete


Looks like no one knows the answer to this question. Could you provide more information about exactly how you run it and what messages are displayed?

joq gravatar image joq  ( 2013-07-27 05:36:42 -0500 )edit

Did update the question with some more information.

TommyP gravatar image TommyP  ( 2013-07-28 01:18:15 -0500 )edit

Have now read the source code and the change that includes the raw message text is not in the source code for rosdoc_lite. It should probably be in the template for the msg.

TommyP gravatar image TommyP  ( 2013-07-29 07:55:48 -0500 )edit

1 Answer

Sort by ยป oldest newest most voted

answered 2013-07-29 14:59:41 -0500

joq gravatar image

For future reference, @TommyP discovered that the fix for this issue (#29) had not been released.

A new rosdoc_lite release should be available soon.

edit flag offensive delete link more

Question Tools


Asked: 2013-03-04 21:45:59 -0500

Seen: 491 times

Last updated: Jul 29 '13