![]() ![]() o OUTPUT_DIRECTORY directory to write documentation to n NAME, -name=NAME Name for documentation set h, -help show this help message and exit When you run the rosdoc command, it will generate documentation into the 'doc' folder of the local directory. You can use rosdoc to generate local copies of documentation. This functionality is mainly only of use to those maintaining documentation Web sites. Rosdoc contains some additional functionality for generating machine-readable documentation files, as well as msg/ srv documentation, that are used by the ros.org wiki system and elsewhere. It is frequently run on packages in ros-pkg and wg-ros-pkg, with the resulting documentation linked to in the "Code API" link of many packages. Rosdoc is used as part of an automated process for updating documentation on ros.org. For example, Doxygen will extract API details from all source files found in the package (see Doxygen for more). The documentation that is generated will depend on which tool is used, as each tool behaves differently. If you wish to use another tool, like Epydoc or Sphinx, you must use a rosdoc configuration file. Doxygen and Sphinx also provide additional tools for authoring documentation that is not tied to code API.īy default, rosdoc will use Doxygen to generate the documentation for a package. ![]() In general, tools like Doxygen search all of the source code in a code tree for structured comments, and then use these comments as well as the API of the code to generate HTML files documenting the package. The documentation is generated on a package-by-package basis - rosdoc does not run on ROS stacks. Rosdoc makes a best effort at providing good default settings to these tools, and in some cases allows these settings to be customized further. We recommend trying rosdoc instead of attempting to setup those tools manually, as it provides shortcuts for configuring those tools and can also import additional ROS information. Rosdoc is simply a tool that runs an external documentation tool, like Doxygen, Epydoc, or Sphinx, on one or more ROS packages. Linking to External Third Party Documentation.rosdoc configuration files (Epydoc, Sphinx).Automatically Generated Online Documentation. ![]()
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |