Doc: extract documentation from all headers #467
Merged
Conversation
We previously went with explicitly adding `@file` directives to our headers instead of using `EXTRACT_ALL` because the latter was broken with the m.css theme that we were using previously. m.css has a custom code generator that didn't support the directive. We've since switched to another theme that just re-styles the vanilla HTML, so we're fine to just use that now (instead of changing the code-gen to add the directives in all generated headers).
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
We previously went with explicitly adding
@filedirectives to our headers instead of usingEXTRACT_ALLbecause the latter was broken with the m.css theme that we were using previously. m.css has a custom code generator that didn't support the directive. We've since switched to another theme that just re-styles the vanilla HTML, so we're fine to just use that now (instead of changing the code-gen to add the directives in all generated headers).Also: update Doxygen CSS theme to latest.
Resolves #465