Javadoc for public API

2 files changed, 65 insertions, 6 deletions

diff --git a/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/sign/IPlainSigner.java b/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/sign/IPlainSigner.java
index 0ad40cc4..70945678 100644
--- a/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/sign/IPlainSigner.java
+++ b/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/sign/IPlainSigner.java
@@ -1,17 +1,41 @@
 package at.gv.egiz.pdfas.lib.api.sign;
 
 import iaik.x509.X509Certificate;
-
-import java.io.IOException;
-
-import org.apache.pdfbox.cos.COSName;
-import org.apache.pdfbox.exceptions.SignatureException;
-
 import at.gv.egiz.pdfas.common.exceptions.PdfAsException;
 
+/**
+ * Signer interface
+ * 
+ * PDF-AS uses an IPlainSigner instance to create the signature. Also custom IPlainSigner
+ * may be used to sign PDF-AS documents.
+ */
 public interface IPlainSigner {
+	
+	/**
+	 * Gets the signing certificate
+	 * @return
+	 * @throws PdfAsException
+	 */
 	public X509Certificate getCertificate() throws PdfAsException;
+	
+	/**
+	 * Sign the document
+	 * @param input
+	 * @param byteRange
+	 * @return
+	 * @throws PdfAsException
+	 */
     public byte[] sign(byte[] input, int[] byteRange) throws PdfAsException;
+    
+    /**
+     * Gets the PDF Subfilter for this signer
+     * @return
+     */
     public String getPDFSubFilter();
+    
+    /**
+     * Gets the PDF Filter for this signer
+     * @return
+     */
     public String getPDFFilter();
 }
diff --git a/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/sign/SignParameter.java b/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/sign/SignParameter.java
index 87ec4068..0b4fb389 100644
--- a/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/sign/SignParameter.java
+++ b/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/sign/SignParameter.java
@@ -5,19 +5,54 @@ import at.gv.egiz.pdfas.lib.api.PdfAsParameter;
 
 public interface SignParameter extends PdfAsParameter {
 	
+	/**
+	 * Gets the signature profile to use
+	 * @return
+	 */
 	public String getSignatureProfileId();
 
+	/**
+	 * Sets the signature profile to use
+	 * 
+	 * @param signatureProfileId The signature profile
+	 */
 	public void setSignatureProfileId(String signatureProfileId);
 
+	/** 
+	 * Gets the signature position
+	 * @return
+	 */
 	public String getSignaturePosition();
 
+	/**
+	 * Sets the signature position
+	 * @param signaturePosition The signature position string
+	 */
 	public void setSignaturePosition(String signaturePosition);
 
+	/**
+	 * Sets the data sink for the signature process
+	 * @param output
+	 */
 	public void setOutput(DataSink output);
 	
+	/**
+	 * Gets the data sink for the signature process
+	 * @return
+	 */
 	public DataSink getOutput();
 	
+	/**
+	 * Sets the signer to use
+	 * 
+	 * 
+	 * @param signer
+	 */
 	public void setPlainSigner(IPlainSigner signer);
 	
+	/**
+	 * Gets the signer to use.
+	 * @return
+	 */
 	public IPlainSigner getPlainSigner();
 }