|
Size: 811
Comment:
|
Size: 913
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = rosdoc = | |
| Line 3: | Line 2: |
[wiki:/Troubleshooting Troubleshooting] |
|
| Line 20: | Line 17: |
| CategoryPackage | [wiki:/Troubleshooting Troubleshooting] ##Please create this page with template "PackageReviewIndex" [wiki:/Reviews Review Process] ## CategoryPackage ## M3Package |
Package Summary
rosdoc provides auto-documentation capabilities across ROS packages via doxygen. It is mainly used to automatically generate documentation on the PR web server, but it can also be invoked manually. Nightly updates are made to:
See also: ["Doxygen"]
To locally generate the documentation for a package (e.g., to see what your documentation looks like before checking it in):
roscd rosdoc ./rosdoc <package-name>
Point your browser at rosdoc/doc/<package-name>/html/index.html to see the results. Note that you need doxygen installed on your machine (e.g., sudo apt-get install doxygen).
[wiki:/Troubleshooting Troubleshooting]
[wiki:/Reviews Review Process]
