-
Notifications
You must be signed in to change notification settings - Fork 20
Add PKCS#11 Doxygen documentation #144
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
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
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
Can one of the admins verify this patch? |
Member
|
CI failures fixed in #145 |
…dd internal.h, store.h, version.h); includes already prefixed where present Co-Authored-By: [email protected] <[email protected]>
…t/key/random/digest/encrypt/sign); fix extensions example code block Co-Authored-By: [email protected] <[email protected]>
…ate docs Co-Authored-By: [email protected] <[email protected]>
…x code-block comments to avoid Doxygen parse issues Co-Authored-By: [email protected] <[email protected]>
…erationState, Create/Copy/Destroy/GetObjectSize/GetAttributeValue) Co-Authored-By: [email protected] <[email protected]>
…FindObjects, EncryptUpdate/Final) Co-Authored-By: [email protected] <[email protected]>
…Final Co-Authored-By: [email protected] <[email protected]>
86970e0 to
f8ab528
Compare
dgarske
approved these changes
Oct 2, 2025
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.
Add PKCS#11 Doxygen documentation from scratch; align headers, fix includes, and use CK_FUNCTION_LIST_PTR examples
Summary
This PR adds comprehensive Doxygen documentation infrastructure and content to wolfPKCS11 from scratch. It provides complete API documentation for the PKCS#11 interface with organized functional groups, extensive code examples, and a proper build system for generating HTML and PDF documentation.
Key Components Added:
CK_FUNCTION_LIST_PTRpattern (p11->C_*calls)pkcs11.h,internal.h,store.h,version.h)Documentation Organization:
<wolfpkcs11/...>formatReview & Testing Checklist for Human
This is a large documentation addition that requires thorough review (5 items):
make dox,make dox-html, andmake dox-pdfto verify generation works correctly and produces expected HTML/PDF outputsCK_FUNCTION_LIST_PTRusage patterndoc/html/index.htmland verify the group organization, search functionality, and cross-references work as expectedNotes
p11->C_*function call pattern for thread safetyLink to Devin run: https://app.devin.ai/sessions/acec576417034f78b1284eb0e614f085
Requested by: [email protected]