UBC-Thunderbots
[DOCS] Added Deoxygen Support
Description
Added Deoxygen support:
see this:
https://mr-anyone.github.io/Thunderbot_Software https://mr-anyone.github.io/Thunderbot_Software/classPlay.html https://mr-anyone.github.io/Thunderbot_Software/classTactic.html https://mr-anyone.github.io/Thunderbot_Software/classThreadedAi.html
see here: https://github.com/Mr-Anyone/Thunderbot_Software
Length Justification and Key Files to Review
Most of it is css file and config file. N/A
It is the reviewers responsibility to also make sure every item here has been covered
- [X] Function & Class comments: All function definitions (usually in the
.hfile) should have a javadoc style comment at the start of them. For examples, see the functions defined inthunderbots/software/geom. Similarly, all classes should have an associated Javadoc comment explaining the purpose of the class. - [X] Remove all commented out code
- [X] Remove extra print statements: for example, those just used for testing
- [X] Resolve all TODO's: All
TODO(or similar) statements should either be completed or associated with a github issue
Small error here. See TOC
looks useful, I think you may have messed up the table of contents rendering in a bunch of markdown files. otherwise, LGTM!
I assume you're referring to how the table of contents is displayed on GitHub (e.g., this page). As far as I can tell, the TOC generated by Doxygen itself is working as intended.
This is a bit painful to fix:
Doxygen uses the [TOC] tag to generate a table of contents (reference). However, GitHub doesn't recognize [TOC]—instead, we’ve been using this tool to create GitHub-compatible TOCs.
The problem is, including both [TOC] and the GitHub-generated TOC leads to formatting issues. On Doxygen pages, you get a random-looking list of pages; on GitHub, you’re left with the [TOC] tag rendered as plain text.
My thinking was to simplify this by moving all documentation to doxygen. I am not sure how to fix the rendering on both Github and doxygen at the same time.
my sense is that right now, most people aren't looking at the locally rendered markdown files and just look online. So it's okay to ignore the markdown table of contents rendering in favour of doxygen (like you've done)
Goodness gracious, rules_doxygen uses MODULE.bazel from bazel 8, if you do use it, can you branch off from the bazel 8 migration branch?
Goodness gracious,
rules_doxygenuses MODULE.bazel from bazel 8, if you do use it, can you branch off from the bazel 8 migration branch?
Sure. I will rebase from your branch or wait until you are done.