Javadoc for public API

1 files changed, 35 insertions, 0 deletions

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();
 }