Fix Doxygen documentation organization and move references into respective subpages #1423
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change Description
The generated Doxygen C++ documentation doesn't seem to properly nest components inside subpages in some instances, and other components had broken links within them. This PR fixes those references and properly nests components.
A visual reference is shown here:
Rationale
C++ documentation is not properly segmented, and I couldn't find any indication why some subpages were in the root and others were in their respective folders, so I assume it wasn't always updated when documentation changed. This makes browsing through the documentation more efficient and readable.
Testing/Review Recommendations
Run Doxygen build process to verify changes are properly reflected and do not break other documentation.
Future Work
Online references to images are broken since markdown expects them to be under img/ locally, so the reference is turned into an html tag but retains the same path, which does not exist as the images are not copied. I've added a section to generate_docs.bash to copy those images within html/img after the documentation generates to enable image references to function properly and could add that to a separate PR to keep this one isolated.