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

ROS documentation "Used By"

asked 2011-07-27 01:40:12 -0600

qdocehf gravatar image

updated 2011-09-03 15:24:49 -0600

kwc gravatar image

On the documentation pages for ROS, found on, each file's page has a section labeled "Used By: ". I assumed that this would be a list of files or packages that included this file, either directly or indirectly. However, some files that I know are included in others, such as XnCppWrapper.h, say that they are "Used By: None". What is this section actually supposed to mean?

edit retag flag offensive close merge delete

2 Answers

Sort by ยป oldest newest most voted

answered 2011-07-27 04:17:08 -0600

AHornung gravatar image

"Used by" in the ROS wiki pages and the API documentation is generated from a package's manifest file. There, the package lists its dependencies on other packages for compilation. This list does not have to be complete (as long as the package compiles) and does not extend to all possible headers installed in the system. The API documentation does not give you all files which include the file you are looking at.

edit flag offensive delete link more


To complement Armin's answer, you should also list package dependencies that are needed at run-time, but not at build-time (e.g., packages whose configuration files are being used).
Adolfo Rodriguez T gravatar image Adolfo Rodriguez T  ( 2011-07-27 18:43:52 -0600 )edit

answered 2011-07-27 04:16:02 -0600

dornhege gravatar image

I think the used by only applies to ros packages.

edit flag offensive delete link more

Question Tools


Asked: 2011-07-27 01:40:12 -0600

Seen: 369 times

Last updated: Jul 27 '11