You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ti...@apache.org on 2016/01/12 23:40:05 UTC

svn commit: r1724332 - /pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/PDAnnotationLink.java

Author: tilman
Date: Tue Jan 12 22:40:05 2016
New Revision: 1724332

URL: http://svn.apache.org/viewvc?rev=1724332&view=rev
Log:
PDFBOX-3190: fix javadoc

Modified:
    pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/PDAnnotationLink.java

Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/PDAnnotationLink.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/PDAnnotationLink.java?rev=1724332&r1=1724331&r2=1724332&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/PDAnnotationLink.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/PDAnnotationLink.java Tue Jan 12 22:40:05 2016
@@ -82,11 +82,10 @@ public class PDAnnotationLink extends PD
     }
 
     /**
-     * Get the action to be performed when this annotation is to be activated.
+     * Get the action to be performed when this annotation is to be activated. Either this or the
+     * destination entry should be set, but not both.
      *
      * @return The action to be performed when this annotation is activated.
-     *
-     * TODO not all annotations have an A entry
      */
     public PDAction getAction()
     {
@@ -96,10 +95,10 @@ public class PDAnnotationLink extends PD
     }
 
     /**
-     * Set the annotation action.
-     * As of PDF 1.6 this is only used for Widget Annotations
+     * Set the annotation action. Either this or the destination entry should be set, but not both.
+     *
      * @param action The annotation action.
-     * TODO not all annotations have an A entry
+     *
      */
     public void setAction( PDAction action )
     {
@@ -138,8 +137,8 @@ public class PDAnnotationLink extends PD
     }
 
     /**
-     * Get the destination to be displayed when the annotation is activated.  Either
-     * this or the A should be set but not both.
+     * Get the destination to be displayed when the annotation is activated. Either this or the
+     * action entry should be set, but not both.
      *
      * @return The destination for this annotation.
      *
@@ -154,7 +153,7 @@ public class PDAnnotationLink extends PD
     }
 
     /**
-     * The new destination value.
+     * The new destination value. Either this or the action entry should be set, but not both.
      *
      * @param dest The updated destination.
      */