CRL doc improvements (#16)

tsaarni · Sep 18, 2023 · 3a65aed · 3a65aed
1 parent ae4f2b8
commit 3a65aed
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/src/main/java/fi/protonode/certy/CertificateRevocationList.java b/lib/src/main/java/fi/protonode/certy/CertificateRevocationList.java
@@ -36,6 +36,10 @@
 import org.bouncycastle.operator.OperatorCreationException;
 import org.bouncycastle.operator.jcajce.JcaContentSignerBuilder;
 
+
+/**
+ * CertificateRevocationList is a builder for X.509 CRLs.
+ */
 public class CertificateRevocationList {
 
     // Attributes set by user via builder methods.
@@ -75,6 +79,7 @@ public CertificateRevocationList nextUpdate(Date val) {
 
     /**
      * Defines the issuer of the CRL.
+     * Issuer will be used to sign the CRL.
      * If the issuer is not set, the issuer of the revoked certificates is used.
      *
      * @param val Instance of {@link Credential} that will be used to sign the CRL.
@@ -87,6 +92,7 @@ public CertificateRevocationList issuer(Credential val) {
 
     /**
      * Adds a revoked certificate to the CRL.
+     * Note that all revoked certificates must have the same issuer.
      *
      * @param val Instance of {@link Credential} that will be revoked.
      * @return The CertificateRevocationList itself.