Fix Doxygen Output #30
Merged
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
alilleybrinker
added
A-docs
|
Hey @cstepanian this is ready for review! 😄 |
|
CC @asteffey, this will make it easier to address improvements to the documentation that we've discussed, and to make sure we can quickly provide @djorgensen-mitre with an up-to-date header file as work continues. |
cstepanian
previously approved these changes
Sep 11, 2020
This commit does three things: * Removes a `.gitkeep` file we do longer need (because the dir has a `.gitignore` too) * Modifies `cbindgen.toml` to put a header at the top of the generated file which tells Doxygen to process it correctly. * Modifies `CMakeLists.txt` to always rerun the header-generator, and further modifies Doxygen configuration as we need, plus some slight style improvement to the Doxygen section of the config.
alilleybrinker
force-pushed
the
fix_doxygen_output
branch
from
8171314 to
b503e2c
Compare
alilleybrinker
added a commit
that referenced
this pull request
Sep 23, 2020
* Update Doxygen configuration in CMake * Make Doxygen generate docs properly This commit does three things: * Removes a `.gitkeep` file we do longer need (because the dir has a `.gitignore` too) * Modifies `cbindgen.toml` to put a header at the top of the generated file which tells Doxygen to process it correctly. * Modifies `CMakeLists.txt` to always rerun the header-generator, and further modifies Doxygen configuration as we need, plus some slight style improvement to the Doxygen section of the config.
alilleybrinker
added a commit
that referenced
this pull request
Nov 4, 2020
* Update Doxygen configuration in CMake * Make Doxygen generate docs properly This commit does three things: * Removes a `.gitkeep` file we do longer need (because the dir has a `.gitignore` too) * Modifies `cbindgen.toml` to put a header at the top of the generated file which tells Doxygen to process it correctly. * Modifies `CMakeLists.txt` to always rerun the header-generator, and further modifies Doxygen configuration as we need, plus some slight style improvement to the Doxygen section of the config.
alilleybrinker
added a commit
that referenced
this pull request
Dec 4, 2020
* Update Doxygen configuration in CMake * Make Doxygen generate docs properly This commit does three things: * Removes a `.gitkeep` file we do longer need (because the dir has a `.gitignore` too) * Modifies `cbindgen.toml` to put a header at the top of the generated file which tells Doxygen to process it correctly. * Modifies `CMakeLists.txt` to always rerun the header-generator, and further modifies Doxygen configuration as we need, plus some slight style improvement to the Doxygen section of the config.
alilleybrinker
added a commit
that referenced
this pull request
Feb 2, 2021
* Update Doxygen configuration in CMake * Make Doxygen generate docs properly This commit does three things: * Removes a `.gitkeep` file we do longer need (because the dir has a `.gitignore` too) * Modifies `cbindgen.toml` to put a header at the top of the generated file which tells Doxygen to process it correctly. * Modifies `CMakeLists.txt` to always rerun the header-generator, and further modifies Doxygen configuration as we need, plus some slight style improvement to the Doxygen section of the config.
alilleybrinker
added a commit
that referenced
this pull request
Apr 22, 2021
* Update Doxygen configuration in CMake * Make Doxygen generate docs properly This commit does three things: * Removes a `.gitkeep` file we do longer need (because the dir has a `.gitignore` too) * Modifies `cbindgen.toml` to put a header at the top of the generated file which tells Doxygen to process it correctly. * Modifies `CMakeLists.txt` to always rerun the header-generator, and further modifies Doxygen configuration as we need, plus some slight style improvement to the Doxygen section of the config.
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.
Previous work got Doxygen set up and working with CMake, but the current Doxygen output is largely useless, for a couple reasons:
This PR aims to resolve these issues.