Initial Framework for Using Doxygen to Document Public Header Files #2908
+3,624
−114
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.
Issues:
Resolves P276033715
Resolves P276038464
Addresses P276034041
Description of changes:
Start of moving AWS-LC over to Doxygen for a documentation framework and automatic publication of documentation with each update to main. This creates the initial configuration files, updates the style guide and includes one converted file as an example.
Call-outs:
The documentation itself is not being updated as part of this work, it is being moved to the Doxygen framework. Updating documentation is future work. Doxygen layout has been customized since this is not a C++ project.
Testing:
Doxygen configuration files and symbol linking have been verified correct with local testing, not yet at the stage for testing via GitHub.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and the ISC license.