[JA] Add missing Japanese dox_comments for 7 API groups - #11024
Open
yosuke-wolfssl wants to merge 1 commit into
Open
[JA] Add missing Japanese dox_comments for 7 API groups#11024yosuke-wolfssl wants to merge 1 commit into
yosuke-wolfssl wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds the missing Japanese Doxygen comment headers and group definitions for seven API groups so the JA documentation build emits the required group__*.md and *_8h.md pages (preventing pdf-prep from hard-failing on unconditional cat).
Changes:
- Added Japanese dox-comment header files for: XMSS, SLH-DSA, SHE, ML-KEM, ML-DSA, LMS, and PUF.
- Added the corresponding
\defgroupentries for those groups in the Japanesedoxygen_groups.hso the group pages are generated.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| doc/dox_comments/header_files-ja/wc_xmss.h | Adds JA Doxygen blocks for XMSS/XMSS^MT APIs under \ingroup XMSS. |
| doc/dox_comments/header_files-ja/wc_slhdsa.h | Adds JA Doxygen blocks for SLH-DSA APIs under \ingroup SLH_DSA. |
| doc/dox_comments/header_files-ja/wc_she.h | Adds JA Doxygen blocks for SHE APIs under \ingroup SHE. |
| doc/dox_comments/header_files-ja/wc_mlkem.h | Adds JA Doxygen blocks for ML-KEM APIs under \ingroup ML_KEM. |
| doc/dox_comments/header_files-ja/wc_mldsa.h | Adds JA Doxygen blocks for ML-DSA APIs under \ingroup ML_DSA. |
| doc/dox_comments/header_files-ja/wc_lms.h | Adds JA Doxygen blocks for LMS/HSS APIs under \ingroup LMS. |
| doc/dox_comments/header_files-ja/puf.h | Adds JA Doxygen blocks for PUF APIs under \ingroup PUF. |
| doc/dox_comments/header_files-ja/doxygen_groups.h | Adds JA \defgroup definitions for the seven groups so Doxygen emits the group pages. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
wolfSSL-Fenrir-bot
left a comment
There was a problem hiding this comment.
Fenrir Automated Review — PR #11024
Scan targets checked: wolfcrypt-rs-bugs
No new issues found in the changed files. ✅
Contributor
Author
|
Hi @JacobBarthelmeh , |
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.
Problem
nightly-JA-docs-jobhas been red for 9 consecutive builds since 2026-07-16.pdf-prepaborts:ef08970in thedocumentationrepo added these 7 groups to the unconditionalcatlists inwolfSSL/Makefile.pdf-prepis shared by both languages, so an English-only addition hard-fails the Japanese PDF; the HTML build survives only becausehtml-prepglobs.Doxyfile-jadiffers fromDoxyfilein one line —INPUT— so the missing pages trace directly to missing Japanese source in this repo. Nodocumentationrepo change is required.Fix (
doc/dox_comments/header_files-ja/)Adds the 7 missing headers (170 comment blocks) and their 7
\defgroupdeclarations.puf.hPUFwc_mlkem.hML_KEMwc_she.hSHEwc_xmss.hXMSSwc_lms.hLMSwc_slhdsa.hSLH_DSAwc_mldsa.hML_DSABoth halves are required, and they satisfy different
catlists.\defgroupgoverns whethergroup__*.mdis emitted at all (appendix02); the header governswc__*_8h.md(appendix03). A header with no\defgroupproduces no group page; a\defgroupwith no header produces only an empty stub.Structure is identical to the English originals — same blocks in the same order, same
\param/\return/\saidentifiers, signatures copied verbatim. Only prose is translated, including comments inside\codeblocks. LMS/XMSS normative text uses~しなければなりませんso the requirement to persist private key state between signings is not weakened.Verification
group__*.xmland 7*_8h.xmlwith zero content warnings; doxybook2 produces all 14 markdown pages.pdf-prepcatlists complete. appendix02\brief/\paramleakage.git diffoverheader_files/is empty.