Improve Doxygen docs
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 245
- Forks
- 36
- Avg merge
- 8d 23h
- Merged PRs (30d)
- 4
Description
I just noticed that some of our doxygen docs pages aren't rendering correctly, for example
https://serac.readthedocs.io/en/latest/doxygen/html/classserac_1_1SolidFunctional.html
I suspect this is because of the fact the initial doxygen block comment is on a forward-declared class. There's also some discussion on the doxygen git repo here that may be relevant, relating to a bug with generating documentation for forward-declared class templates being fixed in v1.8.19
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 with the rendered classserac_1_1SolidFunctional.html page and the issue's Doxygen discussion, then inspect how the initial documentation block is attached to the forward-declared class. Determine whether the project’s Doxygen version or comment placement is responsible; done means the affected Doxygen pages render correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100