docs: improve docs

li0ard · Sep 10, 2024 · a0ff7f5 · a0ff7f5
1 parent 1a5ea19
commit a0ff7f5
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 8 deletions.
diff --git a/src/asn1/pkd.ts b/src/asn1/pkd.ts
@@ -1,9 +1,5 @@
-import { AsnProp, AsnType, AsnPropTypes, AsnTypeTypes, AsnArray } from "@peculiar/asn1-schema";
-import { Certificate } from "@peculiar/asn1-x509";
-
-/** Class for ASN1 schema of Certificates set */
-@AsnType({ type: AsnTypeTypes.Set, itemType: Certificate })
-export class Certificates extends AsnArray<Certificate> {}
+import { CertificateSet } from "@peculiar/asn1-cms";
+import { AsnProp, AsnPropTypes } from "@peculiar/asn1-schema";
 
 /** Class for ASN1 schema of CSCA master list. Described by ICAO 9303 p.12 section 9.2 */
 export class CSCAMasterList {
@@ -12,6 +8,6 @@ export class CSCAMasterList {
     version: number = 0;
 
     /** CSCA certificates */
-    @AsnProp({ type: Certificates })
-    certificates: Certificates = new Certificates()
+    @AsnProp({ type: CertificateSet })
+    certificates: CertificateSet = new CertificateSet()
 }
diff --git a/src/dg2.ts b/src/dg2.ts
@@ -21,6 +21,7 @@ export class DG2 {
     }
     /**
      * Read Biometric data block
+     * @hidden
      * @param tlv 
      */
     readBDB(tlv: TLV): Interfaces.DecodedImage {

diff --git a/src/dg3.ts b/src/dg3.ts
@@ -3,6 +3,7 @@ import { Enums, Interfaces } from "./index";
 
 /**
  * Class for working with DG3 (Fingerprint)
+ * @hideconstructor
  * @experimental
 */
 export class DG3 {
@@ -25,6 +26,7 @@ export class DG3 {
     }
     /**
      * Read Biometric data block
+     * @hidden
      * @param tlv 
      */
     readBDB(tlv: TLV): Interfaces.DecodedFingerprint {

diff --git a/src/dg4.ts b/src/dg4.ts
@@ -3,11 +3,13 @@ import { Enums, Interfaces } from "./index";
 
 /**
  * Class for working with DG4 (Iris)
+ * @hideconstructor
  * @experimental
 */
 export class DG4 {
     /**
      * Extract int from buffer
+     * @hidden
      * @param data Buffer
      * @param start Offset
      * @param end Offset+length

diff --git a/src/pkd.ts b/src/pkd.ts
@@ -4,6 +4,7 @@ import { CSCAMasterList } from "./asn1/pkd";
 
 /**
  * Class for working with CSCA master list
+ * @see [ICAO Masterlist](https://www.icao.int/Security/FAL/PKD/Pages/ICAO-Master-List.aspx)
 */
 export class PKD {
     /**