Merge pull request #9552 from tamasan238/pr9458

[JA] Fix issues with the API documentation

Author: kojo1

doc/dox_comments/header_files-ja/aes.h

@@ -19,7 +19,7 @@
     \sa wc_MakeCert
     \sa wc_MakeCertReq
 */
-int wc_InitCert(Cert*);
+int wc_InitCert(Cert* cert);
 
 /*!
      \ingroup ASN

doc/dox_comments/header_files-ja/asn_public.h

@@ -29,8 +29,8 @@
     \sa wc_CamelliaCbcEncrypt
     \sa wc_CamelliaCbcDecrypt
 */
-int  wc_CamelliaSetKey(Camellia* cam,
-                                   const byte* key, word32 len, const byte* iv);
+int  wc_CamelliaSetKey(wc_Camellia* cam, const byte* key, word32 len,
+                                   const byte* iv);
 
 /*!
     \ingroup Camellia
@@ -55,7 +55,7 @@ int  wc_CamelliaSetKey(Camellia* cam,
 
     \sa wc_CamelliaSetKey
 */
-int  wc_CamelliaSetIV(Camellia* cam, const byte* iv);
+int  wc_CamelliaSetIV(wc_Camellia* cam, const byte* iv);
 
 /*!
     \ingroup Camellia
@@ -80,7 +80,7 @@ int  wc_CamelliaSetIV(Camellia* cam, const byte* iv);
 
     \sa wc_CamelliaDecryptDirect
 */
-int  wc_CamelliaEncryptDirect(Camellia* cam, byte* out,
+int  wc_CamelliaEncryptDirect(wc_Camellia* cam, byte* out,
                                                                 const byte* in);
 
 /*!
@@ -106,7 +106,7 @@ int  wc_CamelliaEncryptDirect(Camellia* cam, byte* out,
 
     \sa wc_CamelliaEncryptDirect
 */
-int  wc_CamelliaDecryptDirect(Camellia* cam, byte* out,
+int  wc_CamelliaDecryptDirect(wc_Camellia* cam, byte* out,
                                                                 const byte* in);
 
 /*!
@@ -133,7 +133,7 @@ int  wc_CamelliaDecryptDirect(Camellia* cam, byte* out,
 
     \sa wc_CamelliaCbcDecrypt
 */
-int wc_CamelliaCbcEncrypt(Camellia* cam,
+int wc_CamelliaCbcEncrypt(wc_Camellia* cam,
                                           byte* out, const byte* in, word32 sz);
 
 /*!
@@ -160,5 +160,5 @@ int wc_CamelliaCbcEncrypt(Camellia* cam,
 
     \sa wc_CamelliaCbcEncrypt
 */
-int wc_CamelliaCbcDecrypt(Camellia* cam,
+int wc_CamelliaCbcDecrypt(wc_Camellia* cam,
                                           byte* out, const byte* in, word32 sz);

doc/dox_comments/header_files-ja/camellia.h

@@ -41,8 +41,8 @@
 int wc_ChaCha20Poly1305_Encrypt(
                 const byte inKey[CHACHA20_POLY1305_AEAD_KEYSIZE],
                 const byte inIV[CHACHA20_POLY1305_AEAD_IV_SIZE],
-                const byte* inAAD, const word32 inAADLen,
-                const byte* inPlaintext, const word32 inPlaintextLen,
+                const byte* inAAD, word32 inAADLen,
+                const byte* inPlaintext, word32 inPlaintextLen,
                 byte* outCiphertext,
                 byte outAuthTag[CHACHA20_POLY1305_AEAD_AUTHTAG_SIZE]);
 
@@ -95,7 +95,7 @@ int wc_ChaCha20Poly1305_Encrypt(
 int wc_ChaCha20Poly1305_Decrypt(
                 const byte inKey[CHACHA20_POLY1305_AEAD_KEYSIZE],
                 const byte inIV[CHACHA20_POLY1305_AEAD_IV_SIZE],
-                const byte* inAAD, const word32 inAADLen,
-                const byte* inCiphertext, const word32 inCiphertextLen,
+                const byte* inAAD, word32 inAADLen,
+                const byte* inCiphertext, word32 inCiphertextLen,
                 const byte inAuthTag[CHACHA20_POLY1305_AEAD_AUTHTAG_SIZE],
                 byte* outPlaintext);

doc/dox_comments/header_files-ja/chacha20_poly1305.h

@@ -482,7 +482,7 @@ int wc_curve25519_import_public_ex(const byte* in, word32 inLen,
     \return BAD_FUNC_ARG 入力パラメータのいずれかがNULLの場合に返されます。
 
     \param [in] pub チェックする公開鍵を含むバッファへのポインタ。
-    \param [in] pubLen チェックする公開鍵の長さ。
+    \param [in] pubSz チェックする公開鍵の長さ。
     \param [in] endian 使用する形式を設定するためのEC25519_BIG_ENDIANまたはEC25519_LITTLE_ENDIAN。
 
     _Example_

doc/dox_comments/header_files-ja/curve25519.h

@@ -480,7 +480,7 @@ int wc_curve448_import_public_ex(const byte* in, word32 inLen,
     \return BAD_FUNC_ARG 入力パラメータのいずれかがNULLの場合に返されます。
 
     \param [in] pub チェックする公開鍵を含むバッファへのポインタ。
-    \param [in] pubLen チェックする公開鍵の長さ。
+    \param [in] pubSz チェックする公開鍵の長さ。
     \param [in] endian 使用する形式を設定するためのEC448_BIG_ENDIANまたはEC448_LITTLE_ENDIAN。
 
     _Example_

doc/dox_comments/header_files-ja/curve448.h

@@ -37,7 +37,7 @@ int wc_InitDhKey(DhKey* key);
 
     \sa wc_InitDhKey
 */
-void wc_FreeDhKey(DhKey* key);
+int wc_FreeDhKey(DhKey* key);
 
 /*!
     \ingroup Diffie-Hellman
@@ -155,7 +155,7 @@ int wc_DhAgree(DhKey* key, byte* agree, word32* agreeSz,
     \sa wc_DhSetKey
 */
 int wc_DhKeyDecode(const byte* input, word32* inOutIdx, DhKey* key,
-                           word32);
+                           word32 inSz);
 
 /*!
     \ingroup Diffie-Hellman

doc/dox_comments/header_files-ja/dh.h

@@ -733,7 +733,7 @@ void wc_ecc_del_point(ecc_point* p);
     \sa wc_ecc_del_point
 */
 
-int wc_ecc_copy_point(ecc_point* p, ecc_point *r);
+int wc_ecc_copy_point(const ecc_point* p, ecc_point *r);
 
 /*!
     \ingroup ECC
@@ -847,7 +847,7 @@ int wc_ecc_point_is_at_infinity(ecc_point *p);
     \sa なし
 */
 
-int wc_ecc_mulmod(mp_int* k, ecc_point *G, ecc_point *R,
+int wc_ecc_mulmod(const mp_int* k, ecc_point *G, ecc_point *R,
                   mp_int* a, mp_int* modulus, int map);
 
 /*!
@@ -1020,7 +1020,7 @@ int wc_ecc_import_x963(const byte* in, word32 inLen, ecc_key* key);
     \param privSz 秘密鍵バッファのサイズ
     \param pub ANSI x9.63形式のECC公開鍵を含むバッファへのポインタ
     \param pubSz 公開鍵入力バッファの長さ
-    \param key インポートされた秘密/公開キーペアを格納するecc_keyオブジェクトへのポインタ
+    \param key インポートされた秘密/公開鍵ペアを格納するecc_keyオブジェクトへのポインタ
 
     _Example_
     \code
@@ -1241,7 +1241,7 @@ int wc_ecc_export_point_der(const int curve_idx, ecc_point* point,
     \sa wc_ecc_export_point_der
 */
 
-int wc_ecc_import_point_der(byte* in, word32 inLen, const int curve_idx,
+int wc_ecc_import_point_der(const byte* in, word32 inLen, const int curve_idx,
                             ecc_point* point);
 
 /*!
@@ -1319,7 +1319,7 @@ int wc_ecc_sig_size_calc(int sz);
     \sa wc_ecc_sig_size_calc
 */
 
-int wc_ecc_sig_size(ecc_key* key);
+int wc_ecc_sig_size(const ecc_key* key);
 
 
 /*!
@@ -1375,7 +1375,7 @@ ecEncCtx* wc_ecc_ctx_new(int flags, WC_RNG* rng);
     \sa wc_ecc_ctx_new
 */
 
-void wc_ecc_ctx_free(ecEncCtx*);
+void wc_ecc_ctx_free(ecEncCtx* ctx);
 
 /*!
     \ingroup ECC

doc/dox_comments/header_files-ja/ecc.h

@@ -173,7 +173,7 @@ int wc_ed25519ctx_sign_msg(const byte* in, word32 inlen, byte* out,
     \param [in] hash 署名するメッセージのハッシュを含むバッファへのポインタ。
     \param [in] hashLen 署名するメッセージのハッシュの長さ。
     \param [out] out 生成された署名を格納するバッファ。
-    \param [in,out] outlen 出力バッファの最大長。メッセージ署名の生成に成功した後、outに書き込まれたバイト数が格納されます。
+    \param [in,out] outLen 出力バッファの最大長。メッセージ署名の生成に成功した後、outに書き込まれたバイト数が格納されます。
     \param [in] key 署名を生成するために使用する秘密ed25519_keyへのポインタ。
     \param [in] context メッセージが署名されているコンテキストを含むバッファへのポインタ。
     \param [in] contextLen コンテキストバッファの長さ。
@@ -373,8 +373,8 @@ int wc_ed25519ctx_verify_msg(const byte* sig, word32 siglen, const byte* msg,
     byte hash[] = { メッセージのSHA-512ハッシュで初期化 };
     byte context[] = { 署名のコンテキストで初期化 };
     // 受信した公開鍵でkeyを初期化
-    ret = wc_ed25519ph_verify_hash(sig, sizeof(sig), msg, sizeof(msg),
-            &verified, &key, );
+    ret = wc_ed25519ph_verify_hash(sig, sizeof(sig), hash, sizeof(hash),
+            &verified, &key, context, sizeof(context));
     if (ret < 0) {
         // 検証実行エラー
     } else if (verified == 0)
@@ -419,8 +419,8 @@ int wc_ed25519ph_verify_hash(const byte* sig, word32 siglen, const byte* hash,
     byte msg[] = { メッセージで初期化 };
     byte context[] = { 署名のコンテキストで初期化 };
     // 受信した公開鍵でkeyを初期化
-    ret = wc_ed25519ctx_verify_msg(sig, sizeof(sig), msg, sizeof(msg),
-            &verified, &key, );
+    ret = wc_ed25519ph_verify_msg(sig, sizeof(sig), msg, sizeof(msg),
+            &verified, &key, context, sizeof(context));
     if (ret < 0) {
         // 検証実行エラー
     } else if (verified == 0)
@@ -429,8 +429,8 @@ int wc_ed25519ph_verify_hash(const byte* sig, word32 siglen, const byte* hash,
     \endcode
 
     \sa wc_ed25519_verify_msg
+    \sa wc_ed25519ctx_verify_msg
     \sa wc_ed25519ph_verify_hash
-    \sa wc_ed25519ph_verify_msg
     \sa wc_ed25519_sign_msg
 */
 
@@ -645,7 +645,7 @@ int wc_ed25519_import_private_key(const byte* priv, word32 privSz,
 
     ed25519_key key;
     wc_ed25519_init_key(&key);
-    ret = wc_ed25519_import_private_key(priv, sizeof(priv), pub, sizeof(pub),
+    ret = wc_ed25519_import_private_key_ex(priv, sizeof(priv), pub, sizeof(pub),
             &key, 1);
     if (ret != 0) {
         // 鍵のインポートエラー
@@ -669,7 +669,7 @@ int wc_ed25519_import_private_key_ex(const byte* priv, word32 privSz,
 
     \return 0 公開鍵のエクスポートに成功した場合に返されます。
     \return BAD_FUNC_ARG 入力値のいずれかがNULLと評価された場合に返されます。
-    \return BUFFER_E 提供されたバッファが秘密鍵を格納するのに十分な大きさでない場合に返されます。このエラーを返す際、関数はoutLenに必要なサイズを設定します。
+    \return BUFFER_E 提供されたバッファが公開鍵を格納するのに十分な大きさでない場合に返されます。このエラーを返す際、関数はoutLenに必要なサイズを設定します。
 
     \param [in] key 公開鍵をエクスポートするed25519_key構造体へのポインタ。
     \param [out] out 公開鍵を格納するバッファへのポインタ。
@@ -692,10 +692,11 @@ int wc_ed25519_import_private_key_ex(const byte* priv, word32 privSz,
 
     \sa wc_ed25519_import_public
     \sa wc_ed25519_import_public_ex
+    \sa wc_ed25519_export_private
     \sa wc_ed25519_export_private_only
 */
 
-int wc_ed25519_export_public(ed25519_key* key, byte* out, word32* outLen);
+int wc_ed25519_export_public(const ed25519_key* key, byte* out, word32* outLen);
 
 /*!
     \ingroup ED25519
@@ -725,11 +726,12 @@ int wc_ed25519_export_public(ed25519_key* key, byte* out, word32* outLen);
     \endcode
 
     \sa wc_ed25519_export_public
+    \sa wc_ed25519_export_private
     \sa wc_ed25519_import_private_key
     \sa wc_ed25519_import_private_key_ex
 */
 
-int wc_ed25519_export_private_only(ed25519_key* key, byte* out, word32* outLen);
+int wc_ed25519_export_private_only(const ed25519_key* key, byte* out, word32* outLen);
 
 /*!
     \ingroup ED25519
@@ -767,7 +769,7 @@ int wc_ed25519_export_private_only(ed25519_key* key, byte* out, word32* outLen);
     \sa wc_ed25519_export_private_only
 */
 
-int wc_ed25519_export_private(ed25519_key* key, byte* out, word32* outLen);
+int wc_ed25519_export_private(const ed25519_key* key, byte* out, word32* outLen);
 
 /*!
     \ingroup ED25519
@@ -805,7 +807,7 @@ int wc_ed25519_export_private(ed25519_key* key, byte* out, word32* outLen);
     \sa wc_ed25519_export_public
 */
 
-int wc_ed25519_export_key(ed25519_key* key,
+int wc_ed25519_export_key(const ed25519_key* key,
                           byte* priv, word32 *privSz,
                           byte* pub, word32 *pubSz);
 
@@ -866,7 +868,7 @@ int wc_ed25519_check_key(ed25519_key* key);
     \sa wc_ed25519_make_key
 */
 
-int wc_ed25519_size(ed25519_key* key);
+int wc_ed25519_size(const ed25519_key* key);
 
 /*!
     \ingroup ED25519
@@ -893,7 +895,7 @@ int wc_ed25519_size(ed25519_key* key);
     \sa wc_ed25519_pub_size
 */
 
-int wc_ed25519_priv_size(ed25519_key* key);
+int wc_ed25519_priv_size(const ed25519_key* key);
 
 /*!
     \ingroup ED25519
@@ -919,7 +921,7 @@ int wc_ed25519_priv_size(ed25519_key* key);
     \sa wc_ed25519_priv_size
 */
 
-int wc_ed25519_pub_size(ed25519_key* key);
+int wc_ed25519_pub_size(const ed25519_key* key);
 
 /*!
     \ingroup ED25519
@@ -946,4 +948,4 @@ int wc_ed25519_pub_size(ed25519_key* key);
     \sa wc_ed25519_sign_msg
 */
 
-int wc_ed25519_sig_size(ed25519_key* key);
+int wc_ed25519_sig_size(const ed25519_key* key);