docs, refactor: translate comments in source code into english.

fibjs · Jul 6, 2023 · 46ab52c · 46ab52c
1 parent db5da8f
commit 46ab52c
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 18 deletions.
diff --git a/idl/zh-cn/PKey.idl b/idl/zh-cn/PKey.idl
@@ -200,7 +200,7 @@ interface PKey : object
      opts 支持以下参数:
      ```JavaScript
      {
-       compress: false // 指定签名以压缩方式输出公钥
+       compress: false // specify whether to output public key in compressed form
      }
      ```
      支持压缩的曲线为：secp192r1, secp192k1, secp256r1, secp256k1, brainpoolP256r1,
@@ -233,9 +233,9 @@ interface PKey : object
      opts 支持以下参数:
      ```JavaScript
      {
-        alg: 0, // 指定签名的 hash 算法，仅在 RSA 时有效，缺省为 0. 支持算法: 0=NONE,1=MD5,2=SHA1,3=SHA224,4=SHA256,5=SHA384,6=SHA512,7=RIPEMD160
-        format: "der", // 指定签名格式，可选为 der 和 raw，缺省为 der
-        recoverable: false // 指定返回可恢复签名，仅在 secp256k1 有效
+        alg: 0, // specify the hash algorithm for signing, only valid for RSA, default is 0. Supported algorithms: 0=NONE,1=MD5,2=SHA1,3=SHA224,4=SHA256,5=SHA384,6=SHA512,7=RIPEMD160
+        format: "der", // specify the signature format, default is der, supported formats: der, raw
+        recoverable: false // specify whether to return a recoverable signature, only valid for secp256k1
      }
      ```
 
@@ -249,8 +249,8 @@ interface PKey : object
      opts 支持以下参数:
      ```JavaScript
      {
-        alg: 0, // 指定签名的 hash 算法，仅在 RSA 时有效，缺省为 0. 支持算法: 0=NONE,1=MD5,2=SHA1,3=SHA224,4=SHA256,5=SHA384,6=SHA512,7=RIPEMD160
-        format: "der" // 指定签名格式，可选为 der 和 raw，缺省为 der
+        alg: 0, // specify the hash algorithm for signing, only valid for RSA, default is 0. Supported algorithms: 0=NONE,1=MD5,2=SHA1,3=SHA224,4=SHA256,5=SHA384,6=SHA512,7=RIPEMD160
+        format: "der" // specify the signature format, default is der, supported formats: der, raw
      }
      ```
 

diff --git a/npm/types/dts/interface/BlsKey.d.ts b/npm/types/dts/interface/BlsKey.d.ts
@@ -67,7 +67,7 @@ declare class Class_BlsKey extends Class_ECKey {
      *      opts 支持以下参数:
      *      ```JavaScript
      *      {
-     *         header: Buffer|string 指定签名使用的应用数据，缺省为空
+     *         header: Buffer|string // specified header for signature, default is empty
      *      }
      *      ```
      * 
@@ -85,7 +85,7 @@ declare class Class_BlsKey extends Class_ECKey {
      *      opts 支持以下参数:
      *      ```JavaScript
      *      {
-     *         header: Buffer|string 指定签名使用的应用数据，缺省为空
+     *         header: Buffer|string // specified header for signature, default is empty
      *      }
      *      ```
      * 
@@ -104,8 +104,8 @@ declare class Class_BlsKey extends Class_ECKey {
      *      opts 支持以下参数:
      *      ```JavaScript
      *      {
-     *         header: Buffer|string, 指定签名使用的应用数据，缺省为空
-     *         proof_header: Buffer|string 指定证明使用的应用数据，缺省为空
+     *         header: Buffer|string, // specified header for signature, default is empty
+     *         proof_header: Buffer|string // specified header for proof, default is empty
      *      }
      *      ```
      * 
@@ -125,8 +125,8 @@ declare class Class_BlsKey extends Class_ECKey {
      *      opts 支持以下参数:
      *      ```JavaScript
      *      {
-     *         header: Buffer|string, 指定签名使用的应用数据，缺省为空
-     *         proof_header: Buffer|string 指定证明使用的应用数据，缺省为空
+     *         header: Buffer|string, // specified header for signature, default is empty
+     *         proof_header: Buffer|string // specified header for proof, default is empty
      *      }
      *      ```
      * 

diff --git a/npm/types/dts/interface/PKey.d.ts b/npm/types/dts/interface/PKey.d.ts
@@ -233,7 +233,7 @@ declare class Class_PKey extends Class_object {
      *      opts 支持以下参数:
      *      ```JavaScript
      *      {
-     *        compress: false， 指定签名以压缩方式输出公钥
+     *        compress: false // specify whether to output public key in compressed form
      *      }
      *      ```
      *      支持压缩的曲线为：secp192r1, secp192k1, secp256r1, secp256k1, brainpoolP256r1,
@@ -278,9 +278,9 @@ declare class Class_PKey extends Class_object {
      *      opts 支持以下参数:
      *      ```JavaScript
      *      {
-     *         alg: 0， 指定签名的 hash 算法，仅在 RSA 时有效，缺省为 0. 支持算法: 0=NONE,1=MD5,2=SHA1,3=SHA224,4=SHA256,5=SHA384,6=SHA512,7=RIPEMD160
-     *         format: "der", 指定签名格式，可选为 der 和 raw，缺省为 der
-     *         recoverable: false 指定返回可恢复签名，仅在 secp256k1 有效
+     *         alg: 0, // specify the hash algorithm for signing, only valid for RSA, default is 0. Supported algorithms: 0=NONE,1=MD5,2=SHA1,3=SHA224,4=SHA256,5=SHA384,6=SHA512,7=RIPEMD160
+     *         format: "der", // specify the signature format, default is der, supported formats: der, raw
+     *         recoverable: false // specify whether to return a recoverable signature, only valid for secp256k1
      *      }
      *      ```
      * 
@@ -298,8 +298,8 @@ declare class Class_PKey extends Class_object {
      *      opts 支持以下参数:
      *      ```JavaScript
      *      {
-     *         alg: 0， 指定签名的 hash 算法，仅在 RSA 时有效，缺省为 0. 支持算法: 0=NONE,1=MD5,2=SHA1,3=SHA224,4=SHA256,5=SHA384,6=SHA512,7=RIPEMD160
-     *         format: "der", 指定签名格式，可选为 der 和 raw，缺省为 der
+     *         alg: 0, // specify the hash algorithm for signing, only valid for RSA, default is 0. Supported algorithms: 0=NONE,1=MD5,2=SHA1,3=SHA224,4=SHA256,5=SHA384,6=SHA512,7=RIPEMD160
+     *         format: "der" // specify the signature format, default is der, supported formats: der, raw
      *      }
      *      ```
      *