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

rosdoc_lite

asked 2013-08-22 04:09:21 -0600

Hunk gravatar image

Hello,

i have groovy and i am using the rosdoc_lite for my documentation. The documentation is working but i get no graphs.

How i can activate call or caller graphs ?

Or How i can config my doxygen config file?

edit retag flag offensive close merge delete

Comments

Are you running rosdoc_lite locally, or via the ROS wiki doc server? Is there an on-line link to your package's docs?

joq gravatar image joq  ( 2013-08-22 06:10:44 -0600 )edit

I get graphs of header file includes: http://ros.org/doc/hydro/api/camera1394/html/dev__camera1394_8h.html Is that what you want?

joq gravatar image joq  ( 2013-08-22 06:11:50 -0600 )edit

yes locally, this header graph i get too. I want a call graph for function that i see which function he is calling like this http://www-scf.usc.edu/~peterchd/doxygen/

Hunk gravatar image Hunk  ( 2013-08-22 20:27:09 -0600 )edit

I only have to modify my config doxygen file but i dont not how i can do this when i am using rosdoc_lite CALL_GRAPH = YES Generate a dependency graph for functions and methods.

Hunk gravatar image Hunk  ( 2013-08-22 20:28:20 -0600 )edit

1 Answer

Sort by ยป oldest newest most voted
1

answered 2013-08-23 06:32:02 -0600

joq gravatar image

updated 2013-08-26 07:32:29 -0600

I recently took over maintenance for rosdoc_lite, but am not yet familiar with the code. Please bear with me while trying to figure this out.

Doxygen is invoked with a template file that sets CALL_GRAPH = NO. I don't see any option for overriding that template file or replacing it with one of your own. Some variables, such as FILE_PATTERNS, can have per-package values defined in rosdoc.yaml, but CALL_GRAPH is not one of them.

The comments immediately before recommend enabling caller graphs only for selected functions, using the \callergraph command. Is that an option for you?

UPDATE: the main purpose of rosdoc_lite is automatically generating documentation for packages listed on the ROS wiki or similar destinations. The main reason for running it locally is to check updates to those docs before committing them.

If your documentation goals differ, running Doxygen directly may make more sense.

edit flag offensive delete link more

Comments

ok i copied this doxygen config and used it with rosdoc_lite -t /path/to/config but i get a few errors

Hunk gravatar image Hunk  ( 2013-08-25 20:44:14 -0600 )edit

I think the -t option is for a tag file, not a doxy configuration file.

joq gravatar image joq  ( 2013-08-26 07:21:08 -0600 )edit

Same idea i ran Doxygen direct and get a good output. Thank you for your help

Hunk gravatar image Hunk  ( 2013-08-26 20:42:44 -0600 )edit

Question Tools

1 follower

Stats

Asked: 2013-08-22 04:09:21 -0600

Seen: 1,139 times

Last updated: Aug 26 '13