Update Doxygen config #2370
Merged
Update Doxygen config #2370
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
LeStarch
approved these changes
Nov 15, 2023
docs/doxygen/Doxyfile
Outdated
| @@ -38,7 +38,8 @@ PROJECT_NAME = "F´ Flight Software - C/C++ Documentation" | |||
| # could be handy for archiving the generated documentation or if some version | |||
| # control system is used. | |||
|
|
|||
| PROJECT_NUMBER = NASA-v1.6.0 | |||
| # commented out to avoid having to update it every release | |||
| # PROJECT_NUMBER = NASA-v1.6.0 | |||
There was a problem hiding this comment.
Is there a better way to fill this in?
There was a problem hiding this comment.
Now using VERSIONED_OUTPUT variable, defaults to devel if not specified.
|
Do you have a branch where I can see the output? |
LeStarch
requested changes
Nov 15, 2023
There was a problem hiding this comment.
The down side of removing those subpage links is that access to the SDD in an ordered fashion disappears.
Yes, you can get to the class documentation, but not easily in the expected flow:
index -> package -> SDD -> c++/class documentation
Can we fix this or discuss?
thomas-bc
commented
Nov 22, 2023
LeStarch
approved these changes
Nov 27, 2023
LeStarch
approved these changes
Nov 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Updates a couple things with regards to Doxygen. I believe no autocoded files were being processed, as
build-*directories were being excluded. Fixed by renaming the build cache.Also removing the
\subpagedirectives as those were going stale and are un-maintainable. Each subpage includes a link to an auto-generated page that list all the classes within, so they weren't needed anyways.Rationale
Fixes #1989