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.

ROS Message API Documentation

roswiki

asked 2012-11-30 11:22:25 -0500

sedwards
1601 ●28 ●43 ●61 http://rosindustrial.swri.edu/

I am having trouble getting ROS message links to work correctly. I have a page: Industrial Robot Spec, that has auto-generated links to ROS messages. For example:<<MsgLink(sensor_msgs/JointState)>> generates this link: http://www.ros.org/doc/api/sensor_msgs/html/msg/JointState.html. The generated link is valid

A similar example:<<MsgLink(industrial_msgs/RobotStatus)>> generates this link: http://www.ros.org/doc/api/industrial_msgs/html/msg/RobotStatus.html. The generated link is invalid.

The message documentation for the RobotStatus message does exist here: http://ros.org/doc/groovy/api/industrial_msgs/html/msg/RobotStatus.html

How do I get the MsgLink macro to point to ros.org/doc/groovy/api or how do I get the message api docs to populate: www.ros.org/doc/api/

edit retag flag offensive close merge delete

add a comment

1 Answer

Sort by » oldest newest most voted

answered 2013-01-09 13:48:02 -0500

130s

10937 ●203 ●339 ●330 http://www.linkedin.co...

updated 2013-01-09 14:23:01 -0500

I have not yet any idea for your 2nd question. For the 1st question,

How do I get the MsgLink macro to point to ros.org/doc/groovy/api

Looking at the code of macro MsgLink, there might not be a way to do that. I opened up a ticket (I have a feeling this ticket might not be prioritized. That said patch is very welcomed).

ps. Your workaround (to use fullpath URL) might be enough (not ideal for sure) for many situations though

edit flag offensive delete link

Comments

As far as I can tell, this is still an issue and I use hard-coded URLs.

I had a look at the code for MsgLink and it seems that one solution could be to add a second case beside MsgLink(msg/type); something like MsgLink(distro/msg/type). But I do not know how appropriate this would be, though.

AndreasGustavsson ( 2018-12-15 15:04:34 -0500 )edit

add a comment

Question Tools

Stats

Asked: 2012-11-30 11:22:25 -0500

Seen: 433 times

Last updated: Jan 09 '13

ROS Message API Documentation edit

1 Answer

Comments

Question Tools

Stats

Related questions

ROS Message API Documentation