Replace ad-hoc API doc entirely with Doxygen #303
+26,732
−7,884
Conversation
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
Signed-off-by: Ganyu (Bruce) Xu <[email protected]>
Signed-off-by: Ganyu (Bruce) Xu <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
liboqs's C API doc is currently generated by some ad-hoc scripts (
_doxygen_pretty) using Jinja2 templates. However, some of the script does not render correctly (see screenshot below).This pull request replaces the ad-hoc script with API doc that is entirely generated from Doxygen. Now
/liboqs/apidisplays a page with a link to/liboqs/api/doxygen, which is the index page of Doxygen's output.