Skip to content

[JA] Add missing Japanese dox_comments for 7 API groups - #11024

Open
yosuke-wolfssl wants to merge 1 commit into
wolfSSL:masterfrom
yosuke-wolfssl:feat/JPdoc
Open

[JA] Add missing Japanese dox_comments for 7 API groups#11024
yosuke-wolfssl wants to merge 1 commit into
wolfSSL:masterfrom
yosuke-wolfssl:feat/JPdoc

Conversation

@yosuke-wolfssl

Copy link
Copy Markdown
Contributor

Problem

nightly-JA-docs-job has been red for 9 consecutive builds since 2026-07-16. pdf-prep aborts:

cat: build/pdf/group__LMS.md: No such file or directory
(same for ML__DSA, ML__KEM, PUF, SHE, SLH__DSA, XMSS)

ef08970 in the documentation repo added these 7 groups to the unconditional cat lists in wolfSSL/Makefile. pdf-prep is shared by both languages, so an English-only addition hard-fails the Japanese PDF; the HTML build survives only because html-prep globs. Doxyfile-ja differs from Doxyfile in one line — INPUT — so the missing pages trace directly to missing Japanese source in this repo. No documentation repo change is required.

Fix (doc/dox_comments/header_files-ja/)

Adds the 7 missing headers (170 comment blocks) and their 7 \defgroup declarations.

File Group Blocks
puf.h PUF 9
wc_mlkem.h ML_KEM 19
wc_she.h SHE 20
wc_xmss.h XMSS 22
wc_lms.h LMS 27
wc_slhdsa.h SLH_DSA 33
wc_mldsa.h ML_DSA 40

Both halves are required, and they satisfy different cat lists. \defgroup governs whether group__*.md is emitted at all (appendix02); the header governs wc__*_8h.md (appendix03). A header with no \defgroup produces no group page; a \defgroup with no header produces only an empty stub.

Structure is identical to the English originals — same blocks in the same order, same \param/\return/\sa identifiers, signatures copied verbatim. Only prose is translated, including comments inside \code blocks. LMS/XMSS normative text uses ~しなければなりません so the requirement to persist private key state between signings is not weakened.

Verification

  • Structural EN/JA diff is empty across all 7 files (1928 tags, 328 signature lines) — so review only has to judge the Japanese prose, not tag or signature correctness.
  • doxygen emits all 7 group__*.xml and 7 *_8h.xml with zero content warnings; doxybook2 produces all 14 markdown pages.
  • All three pdf-prep cat lists complete. appendix02
  • Pages render Japanese prose with C identifiers intact and no raw \brief/\param leakage.
  • English untouchedgit diff over header_files/ is empty.

@yosuke-wolfssl yosuke-wolfssl self-assigned this Jul 31, 2026
Copilot AI review requested due to automatic review settings July 31, 2026 00:29

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 \defgroup entries for those groups in the Japanese doxygen_groups.h so 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 wolfSSL-Fenrir-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fenrir Automated Review — PR #11024

Scan targets checked: wolfcrypt-rs-bugs

No new issues found in the changed files. ✅

@yosuke-wolfssl

Copy link
Copy Markdown
Contributor Author

Hi @JacobBarthelmeh ,
This is the PR for missing JP headers.
Could you review it please ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants