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

rosdoc generation for wiki

asked 2013-02-04 08:04:21 -0500

updated 2013-02-05 05:29:38 -0500

I use the following command to generate a package's documentation:

rosdoc_lite [name-of-pkg]

When inspecting the resulting offline documentation, I noticed that it's different from the one autogenerated for the ros wiki under the Code API tab:[name-of-pkg]/html/index.html

In particular, the online version has all the auxiliary srv:: and cfg:: namespaces (and possibly others) hidden.

Two questions:

  • Is there a way to generate documentation offline which is the same as the online one?
  • If not, what exactly are the differences between the two?
edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted

answered 2013-02-05 04:58:17 -0500

eitan gravatar image

The documentation generated by rosdoc_lite should be the same as the documentation generated locally. I think the reason that you're getting the "srv" and "cfg" namespaces to show up is because you're running rosdoc_lite on a package that has been built. As such, there are a bunch of auto-generated header files that Doxygen is processing that aren't run by the automated doc system.

Do you have a specific package in mind that you're seeing this for? If I know what you're trying to replicate, I can double check that this is, indeed the case.

edit flag offensive delete link more


You're correct - running "make clean" before rosdoc_lite resolved the issue. Thanks!

Ivan Dryanovski gravatar image Ivan Dryanovski  ( 2013-02-05 05:29:02 -0500 )edit

Question Tools


Asked: 2013-02-04 08:04:21 -0500

Seen: 695 times

Last updated: Feb 05 '13