svn commit: r1859390 - /pdfbox/branches/issue45/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDField.java

[ti...@apache.org]

Author: tilman
Date: Thu May 16 15:46:12 2019
New Revision: 1859390

URL: http://svn.apache.org/viewvc?rev=1859390&view=rev
Log:
PDFBOX-4071: improve javadoc, inspired by Lonzak and mkl in SO 56149203 comments

Modified:
    pdfbox/branches/issue45/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDField.java

Modified: pdfbox/branches/issue45/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDField.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/issue45/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDField.java?rev=1859390&r1=1859389&r2=1859390&view=diff
==============================================================================
--- pdfbox/branches/issue45/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDField.java (original)
+++ pdfbox/branches/issue45/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDField.java Thu May 16 15:46:12 2019
@@ -420,8 +420,10 @@ public abstract class PDField implements
     }
 
     /**
-     * Gets the alternate name of the field.
-     * 
+     * Gets the alternate name of the field ("shall be used in place of the actual field name
+     * wherever the field shall be identified in the user interface (such as in error or status
+     * messages referring to the field)").
+     *
      * @return the alternate name of the field
      */
     public String getAlternateFieldName()
@@ -430,9 +432,12 @@ public abstract class PDField implements
     }
 
     /**
-     * This will set the alternate name of the field.
-     * 
-     * @param alternateFieldName the alternate name of the field
+     * This will set the alternate name of the field ("shall be used in place of the actual field
+     * name wherever the field shall be identified in the user interface (such as in error or status
+     * messages referring to the field)"). The text appears as a tool tip in Adobe Reader. Because
+     * of the usage for error or status messages, it should be different for each field.
+     *
+     * @param alternateFieldName the alternate name of the field.
      */
     public void setAlternateFieldName(String alternateFieldName)
     {