You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ms...@apache.org on 2018/07/10 05:45:07 UTC
svn commit: r1835516 -
/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDButton.java
Author: msahyoun
Date: Tue Jul 10 05:45:07 2018
New Revision: 1835516
URL: http://svn.apache.org/viewvc?rev=1835516&view=rev
Log:
PDFBOX-4256: enhance javadoc comment
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDButton.java
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDButton.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDButton.java?rev=1835516&r1=1835515&r2=1835516&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDButton.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDButton.java Tue Jul 10 05:45:07 2018
@@ -122,8 +122,10 @@ public abstract class PDButton extends P
}
/**
- * Returns the selected value. May be empty if NoToggleToOff is set but there is no value
- * selected.
+ * Returns the selected value.
+ *
+ * <p>Off is the default value which will also be returned if the
+ * value hasn't been set at all.
*
* @return A non-null string.
*/