wolfHSM: only document client and server headers #138
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
dgarske
requested changes
Jun 7, 2024
wolfHSM/Doxyfile
Outdated
| *.qsf \ | ||
| *.ice | ||
| # NOTE: Only document public client and server headers (for now) | ||
| FILE_PATTERNS = wh_client.h wh_server.h |
There was a problem hiding this comment.
It might be better / easier to only adjust this in the wolfHSM Makefile.
diff.patch
bigbrett
force-pushed
the
wolfhsm-client-server-fns-only
branch
from
9d8d3a7
to
6cbb858
Compare
dgarske
reviewed
Jun 7, 2024
| @@ -865,7 +865,7 @@ WARN_LOGFILE = | |||
| # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING | |||
| # Note: If this tag is empty the current directory is searched. | |||
|
|
|||
| INPUT = README.md wolfhsm | |||
| INPUT = README.md wolfhsm/wh_client.h wolfhsm/wh_server.h | |||
There was a problem hiding this comment.
In wolfHSM/Makefile there is a typo.
- $(Q)cat src/appendix01.md build/pdf/wh__*8h*.md > build/html/appendix01.md
+ $(Q)cat src/appendix01.md build/html/wh__*8h*.md > build/html/appendix01.md
Did that not work for you?
There was a problem hiding this comment.
It works fine for me as-is. in fact, weirdly it breaks the website when I apply that patch. The right sidebar with the function links disappears. Does it break for you as-is (with build/pdf)?
There was a problem hiding this comment.
I'm sure it would. The perl -i calls on the PDF are fancier, so it ends up being fine. Let's keep it as-is for now.
dgarske
approved these changes
Jun 7, 2024
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.
Only documents public client+server API functions. Tested locally and seems to render fine.