Add PQ documentation#10514
Open
kaleb-himes wants to merge 1 commit into
Open
Conversation
|
Member
|
Jenkins retest this please |
JacobBarthelmeh
previously approved these changes
May 27, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds Doxygen coverage for post-quantum wolfCrypt APIs, expanding documentation for ML-DSA, ML-KEM, LMS/HSS, and XMSS/XMSS^MT, plus group-level descriptions for PQ algorithms.
Changes:
- Added new Doxygen header comment files for ML-DSA, ML-KEM, LMS, and XMSS APIs.
- Added Doxygen groups and overview text for ML-DSA, ML-KEM, SLH-DSA, LMS, and XMSS.
- Documented usage examples, parameter descriptions, and return codes for PQ APIs.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 13 comments.
Show a summary per file
| File | Description |
|---|---|
doc/dox_comments/header_files/wc_xmss.h |
Adds Doxygen comments for XMSS/XMSS^MT APIs. |
doc/dox_comments/header_files/wc_mlkem.h |
Adds Doxygen comments for ML-KEM APIs. |
doc/dox_comments/header_files/wc_mldsa.h |
Adds Doxygen comments for ML-DSA APIs. |
doc/dox_comments/header_files/wc_lms.h |
Adds Doxygen comments for LMS/HSS APIs. |
doc/dox_comments/header_files/doxygen_groups.h |
Adds group-level PQ algorithm descriptions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-Pilot feedback
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
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.
Description
During the team meeting it was noted that the documents lacked PQ algorithm coverage except SLH-DSA. Adding the others and one minor update to SLH-DSA.
Fixes zd#
Testing
How did you test?
Checklist