Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Doxygen documentation organization and move references into respective subpages #1423

Merged
merged 2 commits into from
Apr 29, 2022

Conversation

cadomani
Copy link
Contributor

Originating Project/Creator @cadomani - ABEX (Alabama Burst Energetics eXplorer)
Affected Component Doxygen Documentation
Affected Architectures(s) N/A
Related Issue(s) None
Has Unit Tests (y/n) n
Builds Without Errors (y/n) y
Unit Tests Pass (y/n) N/A
Documentation Included (y/n) n

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:

Original Pull Request
image image

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.

@LeStarch LeStarch merged commit b85a34b into nasa:devel Apr 29, 2022
@LeStarch
Copy link
Collaborator

No code changes, failure is understood. Merging!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants