Skip to content

Commit f9a88e9

Browse files
authored
Merge pull request #75 from kojo1/ja
wolfSSL in Japanese
2 parents 28e76b0 + 72b70ba commit f9a88e9

31 files changed

+16895
-4
lines changed

wolfSSL/Doxyfile-ja

Lines changed: 2471 additions & 0 deletions
Large diffs are not rendered by default.

wolfSSL/Makefile

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,15 @@ APPENDIX= appendix01.md \
2828
appendix07.md \
2929
appendix08.md
3030

31-
PDF = wolfSSL-Manual.pdf
31+
ifeq ($(DOC_LANG),JA)
32+
PDF = wolfSSL-Manual-jp.pdf
33+
HEADER_FILES = header_files-ja
34+
DOXYFILE = Doxyfile-ja
35+
else
36+
PDF = wolfSSL-Manual.pdf
37+
HEADER_FILES = header_files
38+
DOXYFILE = Doxyfile
39+
endif
3240

3341
wolfssl:
3442
@git clone --depth 1 https://github.com/wolfSSL/wolfssl
@@ -40,7 +48,7 @@ wolfssl-update: wolfssl
4048
.PHONY: api
4149
api: wolfssl-update
4250
@mkdir -p api/md
43-
@cp Doxyfile wolfssl/doc
51+
@cp $(DOXYFILE) wolfssl/doc/Doxyfile
4452
@cd wolfssl/doc && doxygen Doxyfile
4553
@PATH=${DOXYBOOK_PATH}:${PATH} doxybook2 --input wolfssl/doc/xml --output api/md --config doxybook.cfg
4654

@@ -56,7 +64,7 @@ html-prep: api
5664
@rm -f build/html/appendix01.md build/html/appendix02.md build/html/appendix03.md
5765
@perl -i -pe "s/(?<=md\#function\-)(.*)(?=\))/\$$1=~s#-#_#gr/ge" build/html/group* build/html/*8h*
5866
@perl -i -pe "s/\/group_/group_/g" build/html/group* build/html/*8h*
59-
@perl -i -pe "s/dox_comments\/header_files\///" build/html/*8h*
67+
@perl -i -pe "s/dox_comments\/$(HEADER_FILES)\///" build/html/*8h*
6068

6169
# Set input format to gfm to fix issues with converted API docs
6270
# Regexes:
@@ -78,7 +86,7 @@ pdf-prep: api
7886
@perl -i -pe "s/^-(-)+$$//" build/pdf/group* build/pdf/*8h*
7987
@perl -i -pe "s/^title:.*//" build/pdf/group* build/pdf/*8h*
8088
@perl -i -pe "s/^Updated on.*//" build/pdf/group* build/pdf/*8h*
81-
@perl -i -pe "s/dox_comments\/header_files\///" build/pdf/*8h*
89+
@perl -i -pe "s/dox_comments\/$(HEADER_fFILES)\///" build/pdf/*8h*
8290
@perl -i -pe "s/^\\\\//" build/pdf/group* build/pdf/*8h*
8391
@perl -i -pe "s/\\\\par/par/g" build/pdf/group* build/pdf/*8h*
8492
@perl -i -pe "s/group__.*.md//g" build/pdf/*8h* build/pdf/chapter*

wolfSSL/mkdocs-ja.yml

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
site_name: wolfSSL Manual
2+
site_url: https://wolfssl.com/
3+
docs_dir: build/html/
4+
site_dir: html
5+
copyright: Copyright © 2022 wolfSSL Inc.
6+
nav:
7+
- "1. 序章": index.md
8+
- "2. wolfSSLのビルド": chapter02.md
9+
- "3. wolfSSL入門": chapter03.md
10+
- "4. 機能": chapter04.md
11+
- "5. ポータビリティ": chapter05.md
12+
- "6. コールバク": chapter06.md
13+
- "7. 鍵と証明書": chapter07.md
14+
- "8. デバッグ": chapter08.md
15+
- "9. ライブラリー設計方針": chapter09.md
16+
- "10. wolfCrypt レファレンス": chapter10.md
17+
- "11. SSLチュートリアル": chapter11.md
18+
- "12. 組み込みシステムへの適用": chapter12.md
19+
- "13. OpenSSL 互換": chapter13.md
20+
- "14. ライセンス": chapter14.md
21+
- "15. サポートとコンサルティング": chapter15.md
22+
- "16. wolfSSLのアップデート": chapter16.md
23+
- "A. wolfSSL API レファレンス":
24+
- "証明書管理 API": group__CertManager.md
25+
- "メモリー操作": group__Memory.md
26+
- "OpenSSL API": group__openSSL.md
27+
- "wolfSSL 証明書と鍵": group__CertsKeys.md
28+
- "wolfSSL 接続、セッション、ネットワークI/O": group__IO.md
29+
- "wolfSSL コンテクストの設定": group__Setup.md
30+
- "wolfSSL エラーの扱いとレポート": group__Debug.md
31+
- "wolfSSL 初期化": group__TLS.md
32+
- "B. wolfCrypt API レファレンス":
33+
- "ASN.1": group__ASN.md
34+
- "ベースエンコード": group__Base__Encoding.md
35+
- "圧縮": group__Compression.md
36+
- "エラーレポート": group__Error.md
37+
- "IoT-Safeモジュール": group__IoTSafe.md
38+
- "鍵と証明書変換": group__Keys.md
39+
- "ロギング": group__Logging.md
40+
- "整数演算 API": group__Math.md
41+
- "乱数生成": group__Random.md
42+
- "署名 API": group__Signature.md
43+
- "wolfCrypt 初期化とクリーンアップ": group__wolfCrypt.md
44+
- "暗号アルゴリズム - 3DES": group__DES.md
45+
- "暗号アルゴリズム - AES": group__AES.md
46+
- "暗号アルゴリズム - ARC4": group__ARC4.md
47+
- "暗号アルゴリズム - BLAKE2": group__BLAKE2.md
48+
- "暗号アルゴリズム - Camellia": group__Camellia.md
49+
- "暗号アルゴリズム - ChaCha": group__ChaCha.md
50+
- "暗号アルゴリズム - ChaCha20_Poly1305": group__ChaCha20Poly1305.md
51+
- "Algorithms - CMAC ": group__CMAC.md
52+
- "コールバック - CryptoCb": group__Crypto.md
53+
- "暗号アルゴリズム - Curve25519": group__Curve25519.md
54+
- "暗号アルゴリズム - Curve448": group__Curve448.md
55+
- "暗号アルゴリズム - DSA": group__DSA.md
56+
- "暗号アルゴリズム - Diffie-Hellman": group__Diffie-Hellman.md
57+
- "暗号アルゴリズム - ECC": group__ECC.md
58+
- "暗号アルゴリズム - ED25519": group__ED25519.md
59+
- "暗号アルゴリズム - ED448": group__ED448.md
60+
- "ECCSI API レファレンス":
61+
- "ECCSI概要": group__ECCSI__Overview.md
62+
- "ECCSI鍵の設定": group__ECCSI__Setup.md
63+
- "ECCSI鍵による署名、検証": group__ECCSI__Operations.md
64+
- "SAKKE API レファレンス":
65+
- "SAKKE鍵の概要": group__SAKKE__Overview.md
66+
- "SAKKE鍵の設定": group__SAKKE__Setup.md
67+
- "SAKKE RSK操作": group__SAKKE__RSK.md
68+
- "SAKKE 鍵操作": group__SAKKE__Operations.md
69+
- "暗号アルゴリズム - HMAC": group__HMAC.md
70+
- "暗号アルゴリズム - MD2": group__MD2.md
71+
- "暗号アルゴリズム - MD4": group__MD4.md
72+
- "暗号アルゴリズム - MD5": group__MD5.md
73+
- "暗号アルゴリズム - Password Based": group__Password.md
74+
- "暗号アルゴリズム - PKCS7": group__PKCS7.md
75+
- "暗号アルゴリズム - PKCS11": group__PKCS11.md
76+
- "暗号アルゴリズム - Poly1305": group__Poly1305.md
77+
- "暗号アルゴリズム - PSA": group__PSA.md
78+
- "暗号アルゴリズム - RIPEMD": group__RIPEMD.md
79+
- "暗号アルゴリズム - RSA": group__RSA.md
80+
- "暗号アルゴリズム - SHA 128/224/256/384/512": group__SHA.md
81+
- "暗号アルゴリズム - SipHash": group__SipHash.md
82+
- "暗号アルゴリズム - SRP": group__SRP.md
83+
- "C. API ヘッダーファイル":
84+
- aes_8h.md
85+
- arc4_8h.md
86+
- asn_8h.md
87+
- blake2_8h.md
88+
- bn_8h.md
89+
- camellia_8h.md
90+
- chacha20__poly1305_8h.md
91+
- chacha_8h.md
92+
- cmac_8h.md
93+
- coding_8h.md
94+
- compress_8h.md
95+
- cryptocb_8h.md
96+
- curve25519_8h.md
97+
- curve448_8h.md
98+
- des3_8h.md
99+
- dh_8h.md
100+
- doxygen__groups_8h.md
101+
- doxygen__pages_8h.md
102+
- dsa_8h.md
103+
- ecc_8h.md
104+
- eccsi_8h.md
105+
- ed25519_8h.md
106+
- ed448_8h.md
107+
- error-crypt_8h.md
108+
- evp_8h.md
109+
- hash_8h.md
110+
- hmac_8h.md
111+
- iotsafe_8h.md
112+
- logging_8h.md
113+
- md2_8h.md
114+
- md4_8h.md
115+
- md5_8h.md
116+
- memory_8h.md
117+
- pem_8h.md
118+
- pkcs11_8h.md
119+
- pkcs7_8h.md
120+
- poly1305_8h.md
121+
- psa_8h.md
122+
- pwdbased_8h.md
123+
- quic_8h.md
124+
- random_8h.md
125+
- ripemd_8h.md
126+
- rsa_8h.md
127+
- sakke_8h.md
128+
- sha256_8h.md
129+
- sha512_8h.md
130+
- sha_8h.md
131+
- signature_8h.md
132+
- siphash_8h.md
133+
- srp_8h.md
134+
- ssl_8h.md
135+
- tfm_8h.md
136+
- types_8h.md
137+
- wc__encrypt_8h.md
138+
- wc__port_8h.md
139+
- wolfio_8h.md
140+
- "D. SSL/TLS の概要": appendix04.md
141+
- "E. RFC, 仕様および参照": appendix05.md
142+
- "F. エラーコード": appendix06.md
143+
- "G. ポスト量子暗号の実験": appendix07.md
144+
- "H. wolfSSL 移植ガイド": appendix08.md
145+
theme:
146+
name: null
147+
custom_dir: ../mkdocs-material/material
148+
language: ja
149+
palette:
150+
primary: indigo
151+
accent: indigo
152+
font:
153+
text: Roboto
154+
code: Roboto Mono
155+
icon: "logo.png"
156+
logo: logo.png
157+
favicon: logo.png
158+
feature:
159+
tabs: true
160+
extra_css: [skin.css]
161+
extra:
162+
generator: false
163+
use_directory_urls: false

wolfSSL/src-ja/appendix01.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
3+
# wolfSSL APIリファレンス

wolfSSL/src-ja/appendix02.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
3+
# WolfCrypt APIリファレンス

wolfSSL/src-ja/appendix03.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
3+
# APIヘッダーファイル

0 commit comments

Comments
 (0)