From ebf049402a10f8a4cf5612496d5c6daf64a7081a Mon Sep 17 00:00:00 2001
From: pdanner <pdanner@7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c>
Date: Mon, 6 Dec 2010 18:02:38 +0000
Subject: Added javadoc

git-svn-id: https://joinup.ec.europa.eu/svn/pdf-as/trunk@689 7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c
---
 src/main/java/at/gv/egiz/pdfas/api/PdfAs.java | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

(limited to 'src/main/java/at/gv/egiz/pdfas/api')

diff --git a/src/main/java/at/gv/egiz/pdfas/api/PdfAs.java b/src/main/java/at/gv/egiz/pdfas/api/PdfAs.java
index 66035db..26bbace 100644
--- a/src/main/java/at/gv/egiz/pdfas/api/PdfAs.java
+++ b/src/main/java/at/gv/egiz/pdfas/api/PdfAs.java
@@ -7,6 +7,7 @@ import java.util.List;
 
 import at.gv.egiz.pdfas.api.analyze.AnalyzeParameters;
 import at.gv.egiz.pdfas.api.analyze.AnalyzeResult;
+import at.gv.egiz.pdfas.api.analyze.NonTextObjectInfo;
 import at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum;
 import at.gv.egiz.pdfas.api.commons.DynamicSignatureProfile;
 import at.gv.egiz.pdfas.api.commons.SignatureProfile;
@@ -14,6 +15,7 @@ import at.gv.egiz.pdfas.api.exceptions.PdfAsException;
 import at.gv.egiz.pdfas.api.sign.SignParameters;
 import at.gv.egiz.pdfas.api.sign.SignResult;
 import at.gv.egiz.pdfas.api.sign.SignatureDetailInformation;
+import at.gv.egiz.pdfas.api.sign.pos.SignaturePosition;
 import at.gv.egiz.pdfas.api.verify.VerifyAfterAnalysisParameters;
 import at.gv.egiz.pdfas.api.verify.VerifyAfterReconstructXMLDsigParameters;
 import at.gv.egiz.pdfas.api.verify.VerifyParameters;
@@ -231,19 +233,24 @@ public interface PdfAs
   public DynamicSignatureProfile loadDynamicSignatureProfile(String profileName);
   
   /**
-   * TODO doc
+   * Prepares the signature of the given PDF document. The table for the signature data is placed but not filled.<br/>
+   * Usually used for preview.
    * 
    * @param signParameters
-   * @return
-   * @throws PdfAsException
+   *          The sign parameters.
+   * @return Only the {@link SignatureDetailInformation#getSignaturePosition()}, {@link SignatureDetailInformation#getNonTextualObjects()}, {@link SignatureDetailInformation#getSignatureData()} are filled.
+   * @throws PdfAsException if something goes wrong during the process
    */
   public SignatureDetailInformation prepareSign(SignParameters signParameters) throws PdfAsException;
   
   /**
-   * TODO doc
+   * Finish the signature process. The PDF is filled with the signature data.<br/>
+   * Usually used if some steps like the actual signing are to be performed externally.
    * 
    * @param signParameters
+   *          The sign parameters.
    * @param signatureDetailInformation
+   *          The signature detail information.
    * @return
    * @throws PdfAsException
    */
-- 
cgit v1.2.3