Latest Doxygen docs does not seem to include all files
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 805
- Forks
- 564
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 27
Description
Expected behavior
Documentation of classes such as GenericSubscription should be in the documentation at https://docs.ros2.org/latest/api/rclcpp/
Actual behavior
Classes don't appear at all - not even in the class index: https://docs.ros2.org/latest/api/rclcpp/classes.html#letter_g
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the latest rclcpp Doxygen output at the linked API pages, checking whether GenericSubscription and similar classes are absent from the class index. Trace the documentation-generation configuration used for rclcpp and confirm that the missing classes appear in a regenerated output; done means the classes are documented and indexed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100