update pkcs8 docs

cagstech · Sep 27, 2023 · 69f15a0 · 69f15a0
1 parent 37ddab5
commit 69f15a0
Show file tree

Hide file tree

Showing 7 changed files with 74 additions and 86 deletions.
diff --git a/cryptx.h b/cryptx.h
@@ -576,24 +576,23 @@ size_t cryptx_base64_decode(void *dest, const void *src, size_t len);
 struct cryptx_pkcs8_pubkeyinfo {
   /** Stores root OBJECT IDENTIFIER. This will likely be the type of public key.  */
   struct _objectid {
-    uint8_t data[32];     /** OBJECT IDENTIFIER bytes.  */
-    size_t len;           /** OBJECT IDENTIFIER length. */
+    uint8_t data[32];     /// OBJECT IDENTIFIER bytes.
+    size_t len;           /// OBJECT IDENTIFIER length.
   } objectid;
   /** Stores public key raw data.  */
   struct _publickey {
-    uint8_t data[257];    /** Stores key data (public modulus for RSA or public key for ECC. */
-    size_t len;           /** Length of public modulus or public key. */
-    uint24_t exponent;    /** Public exponent for RSA. Unused for ECC. */
+    uint8_t data[257];    /// Stores key data (public modulus for RSA or public key for ECC. */
+    size_t len;           /// Length of public modulus or public key. */
+    uint24_t exponent;    /// Public exponent for RSA. Unused for ECC. */
   } publickey;
 };
 
 /// Defines response codes returned by the PKCS8 API.
 typedef enum {
   PKCS_OK,
   PKCS_INVALID_ARG,
-  PKCS_INVALID_STRUCT,
+  PKCS_UNSUPPORTED,
   PKCS_INVALID_DATA,
-  PKCS_UNSUPPORTED
 } pkcs_error_t;
 
 /**

diff --git a/docs/doxygen/xml/cryptx_8h.xml b/docs/doxygen/xml/cryptx_8h.xml
diff --git a/docs/doxygen/xml/index.xml b/docs/doxygen/xml/index.xml
@@ -192,9 +192,8 @@
     <member refid="cryptx_8h_1a18ac3fbeea8ba7f7931796bd253131a4" kind="enum"><name>pkcs_error_t</name></member>
     <member refid="cryptx_8h_1a18ac3fbeea8ba7f7931796bd253131a4ae3e1b5568f600f599b65921673580a3b" kind="enumvalue"><name>PKCS_OK</name></member>
     <member refid="cryptx_8h_1a18ac3fbeea8ba7f7931796bd253131a4ad51855979f8e263227e0fba2132d462f" kind="enumvalue"><name>PKCS_INVALID_ARG</name></member>
-    <member refid="cryptx_8h_1a18ac3fbeea8ba7f7931796bd253131a4a11d48b098df8071ab0bfd7c3c8f38a6a" kind="enumvalue"><name>PKCS_INVALID_STRUCT</name></member>
-    <member refid="cryptx_8h_1a18ac3fbeea8ba7f7931796bd253131a4ad98753e06ce91e41e842d85a5c7b139b" kind="enumvalue"><name>PKCS_INVALID_DATA</name></member>
     <member refid="cryptx_8h_1a18ac3fbeea8ba7f7931796bd253131a4a31909947f498b908e7709718c2ddf96f" kind="enumvalue"><name>PKCS_UNSUPPORTED</name></member>
+    <member refid="cryptx_8h_1a18ac3fbeea8ba7f7931796bd253131a4ad98753e06ce91e41e842d85a5c7b139b" kind="enumvalue"><name>PKCS_INVALID_DATA</name></member>
     <member refid="cryptx_8h_1a791c9616d63340d5f3d55673abefd768" kind="variable"><name>x</name></member>
     <member refid="cryptx_8h_1a9671c45fbc76e3760ed5b891992cf94a" kind="variable"><name>y</name></member>
     <member refid="cryptx_8h_1a70b79d7bbba52b64700123ab77ab5a28" kind="function"><name>cryptx_hash_init</name></member>

diff --git a/docs/doxygen/xml/structcryptx__ecc__point.xml b/docs/doxygen/xml/structcryptx__ecc__point.xml
@@ -16,7 +16,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="/Users/acagliano/Library/Mobile Documents/com~apple~CloudDocs/Repositories/toolchain/src/cryptx/cryptx.h" line="688" column="9" bodyfile="/Users/acagliano/Library/Mobile Documents/com~apple~CloudDocs/Repositories/toolchain/src/cryptx/cryptx.h" bodystart="688" bodyend="-1"/>
+        <location file="/Users/acagliano/Library/Mobile Documents/com~apple~CloudDocs/Repositories/toolchain/src/cryptx/cryptx.h" line="687" column="9" bodyfile="/Users/acagliano/Library/Mobile Documents/com~apple~CloudDocs/Repositories/toolchain/src/cryptx/cryptx.h" bodystart="687" bodyend="-1"/>
       </memberdef>
       <memberdef kind="variable" id="structcryptx__ecc__point_1ada79cb09d73636479cf469e6de935973" prot="public" static="no" mutable="no">
         <type>uint8_t</type>
@@ -30,15 +30,15 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="/Users/acagliano/Library/Mobile Documents/com~apple~CloudDocs/Repositories/toolchain/src/cryptx/cryptx.h" line="689" column="9" bodyfile="/Users/acagliano/Library/Mobile Documents/com~apple~CloudDocs/Repositories/toolchain/src/cryptx/cryptx.h" bodystart="689" bodyend="-1"/>
+        <location file="/Users/acagliano/Library/Mobile Documents/com~apple~CloudDocs/Repositories/toolchain/src/cryptx/cryptx.h" line="688" column="9" bodyfile="/Users/acagliano/Library/Mobile Documents/com~apple~CloudDocs/Repositories/toolchain/src/cryptx/cryptx.h" bodystart="688" bodyend="-1"/>
       </memberdef>
       </sectiondef>
     <briefdescription>
 <para>Defines a point for use with elliptic curve arithmetic. </para>
     </briefdescription>
     <detaileddescription>
     </detaileddescription>
-    <location file="/Users/acagliano/Library/Mobile Documents/com~apple~CloudDocs/Repositories/toolchain/src/cryptx/cryptx.h" line="687" column="1" bodyfile="/Users/acagliano/Library/Mobile Documents/com~apple~CloudDocs/Repositories/toolchain/src/cryptx/cryptx.h" bodystart="687" bodyend="690"/>
+    <location file="/Users/acagliano/Library/Mobile Documents/com~apple~CloudDocs/Repositories/toolchain/src/cryptx/cryptx.h" line="686" column="1" bodyfile="/Users/acagliano/Library/Mobile Documents/com~apple~CloudDocs/Repositories/toolchain/src/cryptx/cryptx.h" bodystart="686" bodyend="689"/>
     <listofallmembers>
       <member refid="structcryptx__ecc__point_1a7a6b80237baf8237385a5827601d1337" prot="public" virt="non-virtual"><scope>cryptx_ecc_point</scope><name>x</name></member>
       <member refid="structcryptx__ecc__point_1ada79cb09d73636479cf469e6de935973" prot="public" virt="non-virtual"><scope>cryptx_ecc_point</scope><name>y</name></member>

diff --git a/docs/www/genindex.html b/docs/www/genindex.html
@@ -372,12 +372,10 @@ <h2 id="P">P</h2>
       <li><a href="modules/pkcs8.html#_CPPv412pkcs_error_t">pkcs_error_t (C++ enum)</a>
 </li>
       <li><a href="modules/pkcs8.html#_CPPv4N12pkcs_error_t16PKCS_INVALID_ARGE">pkcs_error_t::PKCS_INVALID_ARG (C++ enumerator)</a>
-</li>
-      <li><a href="modules/pkcs8.html#_CPPv4N12pkcs_error_t17PKCS_INVALID_DATAE">pkcs_error_t::PKCS_INVALID_DATA (C++ enumerator)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="modules/pkcs8.html#_CPPv4N12pkcs_error_t19PKCS_INVALID_STRUCTE">pkcs_error_t::PKCS_INVALID_STRUCT (C++ enumerator)</a>
+      <li><a href="modules/pkcs8.html#_CPPv4N12pkcs_error_t17PKCS_INVALID_DATAE">pkcs_error_t::PKCS_INVALID_DATA (C++ enumerator)</a>
 </li>
       <li><a href="modules/pkcs8.html#_CPPv4N12pkcs_error_t7PKCS_OKE">pkcs_error_t::PKCS_OK (C++ enumerator)</a>
 </li>

diff --git a/docs/www/objects.inv b/docs/www/objects.inv
diff --git a/docs/www/searchindex.js b/docs/www/searchindex.js