Skip to content

Commit 8272870

Browse files
authored
Merge pull request #6720 from TakayukiMatsuo/jp6506
Apdate Japanese API comments to match them in PR6506
2 parents 3033371 + 174f0b2 commit 8272870

7 files changed

Lines changed: 4658 additions & 1144 deletions

File tree

doc/dox_comments/header_files-ja/asn_public.h

Lines changed: 1888 additions & 42 deletions
Large diffs are not rendered by default.

doc/dox_comments/header_files-ja/cmac.h

Lines changed: 51 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
/*!
22
\ingroup CMAC
3-
\brief Cmac 構造体をデフォルトで初期化する
4-
\return 成功したら 0 を返す
5-
\param cmac Cmac 構造体へのポインタ
6-
\param キー キー ポインタ
7-
\param keySz キー ポインタのサイズ (16、24、または 32)
8-
\param type 常に WC_CMAC_AES = 1
9-
\param 未使用 使用されていません。互換性に関する将来の潜在的な使用のために存在します
3+
\brief Cmac構造体をデフォルト値で初期化します
4+
\return 成功したら0を返します
5+
\param cmac Cmac構造体へのポインタ
6+
\param key 鍵データへのポインタ
7+
\param keySz 鍵データのサイズ(16、24、または 32)
8+
\param type 常にWC_CMAC_AES(=1)
9+
\param unused 使用されていません。互換性に関する将来の潜在的な使用のために存在します
1010
1111
_例_
1212
\code
1313
Cmac cmac[1];
14-
ret = wc_InitCmac(cmac、キー、keySz、WC_CMAC_AES、NULL);
15-
もし (ret == 0) {
14+
ret = wc_InitCmac(cmac、key、keySz、WC_CMAC_AES、NULL);
15+
if (ret == 0) {
1616
ret = wc_CmacUpdate(cmac、in、inSz);
1717
}
18-
もし (ret == 0) {
18+
if (ret == 0) {
1919
ret = wc_CmacFinal(cmac, out, outSz);
2020
}
2121
\endcode
@@ -25,29 +25,29 @@
2525
\sa wc_CmacFinal
2626
*/
2727
int wc_InitCmac(Cmac* cmac,
28-
const byte* キーword32 keySz
29-
int型void*未使用);
28+
const byte* keyword32 keySz
29+
int typevoid* unused);
3030

3131
/*!
3232
\ingroup CMAC
33-
\brief Cmac 構造体をデフォルトで初期化する
34-
\return 成功したら 0 を返す
35-
\param cmac Cmac 構造体へのポインタ
36-
\param キー キー ポインタ
37-
\param keySz キー ポインタのサイズ (16、24、または 32)
38-
\param type 常に WC_CMAC_AES = 1
39-
\param 未使用 使用されていません。互換性に関する将来の潜在的な使用のために存在します
40-
\param heap 動的割り当てに使用されるヒープ ヒントへのポインター。 通常、スタティック メモリ オプションで使用されます。 NULL にすることができます
41-
\param devId 非同期ハードウェアで使用する ID。 非同期ハードウェアを使用していない場合は、INVALID_DEVID に設定します
33+
\brief Cmac構造体をデフォルト値で初期化します
34+
\return 成功したら0を返します
35+
\param cmac Cmac構造体へのポインタ
36+
\param key 鍵データへのポインタ
37+
\param keySz 鍵データのサイズ(16、24、または 32)
38+
\param type 常にWC_CMAC_AES(=1)
39+
\param unused 使用されていません。互換性に関する将来の潜在的な使用のために存在します
40+
\param heap 動的割り当てに使用されるヒープヒントへのポインタ。 通常、スタティックメモリオプションで使用されます。 NULLにすることができます
41+
\param devId 非同期ハードウェアで使用するID。非同期ハードウェアを使用していない場合は、INVALID_DEVIDに設定します
4242
4343
_例_
4444
\code
4545
Cmac cmac[1];
46-
ret = wc_InitCmac_ex(cmac、キー、keySzWC_CMAC_AESNULLNULLINVALID_DEVID);
47-
もし (ret == 0) {
48-
ret = wc_CmacUpdate(cmac、in、inSz);
46+
ret = wc_InitCmac_ex(cmac, key, keySz, WC_CMAC_AES, NULL, NULL, INVALID_DEVID);
47+
if (ret == 0) {
48+
ret = wc_CmacUpdate(cmac, in, inSz);
4949
}
50-
もし (ret == 0) {
50+
if (ret == 0) {
5151
ret = wc_CmacFinal(cmac, out, &outSz);
5252
}
5353
\endcode
@@ -57,15 +57,15 @@ int wc_InitCmac(Cmac* cmac,
5757
\sa wc_CmacFinal
5858
*/
5959
int wc_InitCmac_ex(Cmac* cmac,
60-
const byte* キーword32 keySz
61-
int void* 未使用void* ヒープint devId);
60+
const byte* key, word32 keySz,
61+
int type, void* unusedvoid* heap, int devId);
6262

6363
/*!
6464
\ingroup CMAC
6565
\brief 暗号ベースのメッセージ認証コード入力データを追加
66-
\return 成功したら 0 を返す
67-
\param cmac Cmac 構造体へのポインタ
68-
\param in 処理する入力データの
66+
\return 成功したら0を返します
67+
\param cmac Cmac構造体へのポインタ
68+
\param in 処理する入力データへのポインタ
6969
\param inSz 入力データのサイズ
7070
7171
_例_
@@ -81,11 +81,11 @@ int wc_CmacUpdate(Cmac* cmac,
8181

8282
/*!
8383
\ingroup CMAC
84-
\brief 暗号ベースのメッセージ認証コードを使用して最終結果を生成する
85-
\return 成功したら 0 を返す
86-
\param cmac Cmac 構造体へのポインタ
87-
\param out 結果を返すポインタ
88-
\param outSz 出力のポインタサイズ (in/out)
84+
\brief 暗号ベースのメッセージ認証コードを使用して最終結果を生成します
85+
\return 成功したら0を返します
86+
\param cmac Cmac構造体へのポインタ
87+
\param out 結果の出力先バッファへのポインタ
88+
\param outSz 結果の出力先バッファサイズ (in/out)
8989
9090
_例_
9191
\code
@@ -100,14 +100,14 @@ int wc_CmacFinal(Cmac* cmac,
100100

101101
/*!
102102
\ingroup CMAC
103-
\brief CMAC を生成するためのシングル ショット関数
104-
\return 成功したら 0 を返す
105-
\param out 結果を返すポインタ
103+
\brief CMACを生成するためのシングルショット関数
104+
\return 成功したら0を返します
105+
\param out 結果の出力先バッファへのポインタ
106106
\param outSz 出力のポインタサイズ (in/out)
107-
\param in 処理する入力データのポインタ
107+
\param in 処理する入力データのポインタ
108108
\param inSz 入力データのサイズ
109-
\param キー キー ポインタ
110-
\param keySz キー ポインタのサイズ (16、24、または 32)
109+
\param key 鍵データへのポインタ
110+
\param keySz 鍵データのサイズ (16、24、または 32)
111111
112112
_例_
113113
\code
@@ -122,14 +122,14 @@ int wc_AesCmacGenerate(byte* out, word32* outSz,
122122

123123
/*!
124124
\ingroup CMAC
125-
\brief CMAC を検証するためのシングル ショット機能
126-
\return 成功したら 0 を返す
127-
\param 結果を返すチェック ポインタ
128-
\param checkSz チェックアウト バッファのサイズ
125+
\brief CMACを検証するためのシングルショット関数
126+
\return 成功したら0を返します
127+
\param check 検証対象となるCMAC処理結果データへのポインタ
128+
\param checkSz CMAC処理結果データのサイズ
129129
\param in 処理する入力データのポインタ
130130
\param inSz 入力データのサイズ
131-
\param キー キー ポインタ
132-
\param keySz キー ポインタのサイズ (16、24、または 32)
131+
\param key 鍵データへのポインタ
132+
\param keySz 鍵データのサイズ (16、24、または 32)
133133
134134
_例_
135135
\code
@@ -145,9 +145,10 @@ int wc_AesCmacVerify(const byte* check, word32 checkSz,
145145

146146
/*!
147147
\ingroup CMAC
148-
\brief ハードウェアがシングル ショットを必要とし、更新をメモリにキャッシュする必要がある場合にのみ、WOLFSSL_HASH_KEEP で使用されます
149-
\return 成功したら 0 を返す
150-
処理する入力データの \param
148+
\brief WOLFSSL_HASH_KEEPマクロ定義時のみ使用可能。ハードウェアがシングルショットを必要とし、更新をメモリにキャッシュする必要がある場合に使用します。
149+
\return 成功したら0を返します
150+
\param cmac Cmac構造体へのポインタ
151+
\param in 処理する入力データへのポインタ
151152
\param inSz 入力データのサイズ
152153
153154
_例_

0 commit comments

Comments
 (0)