ROS documentation "Used By"

documentation

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

qdocehf
208 ●22 ●28 ●32

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

On the documentation pages for ROS, found on http://www.ros.org/doc/api/index.html, 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

add a comment

1

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

AHornung

5904 ●43 ●74 ●102 http://www.informatik....

"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

Comments

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).