svn commit: r1889068 - /pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNumberTreeNode.java

[ti...@apache.org]

Author: tilman
Date: Wed Apr 21 16:33:40 2021
New Revision: 1889068

URL: http://svn.apache.org/viewvc?rev=1889068&view=rev
Log:
PDFBOX-5164: improve javadoc

Modified:
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNumberTreeNode.java

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNumberTreeNode.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNumberTreeNode.java?rev=1889068&r1=1889067&r2=1889068&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNumberTreeNode.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNumberTreeNode.java Wed Apr 21 16:33:40 2021
@@ -105,7 +105,9 @@ public class PDNumberTreeNode implements
     /**
      * Set the children of this number tree.
      *
-     * @param kids The children of this number tree.
+     * @param kids The children of this number tree. These have to be in sorted order. Because of
+     * that, it is usually easier to call {@link setNumbers} with a map and pass a single element
+     * list here.
      */
     public void setKids( List<? extends PDNumberTreeNode> kids )
     {
@@ -235,7 +237,7 @@ public class PDNumberTreeNode implements
 
     /**
      * Set the numbers for this node. This method will set the appropriate upper and lower limits
-     * based on the keys in the map.
+     * based on the keys in the map and take care of the ordering.
      *
      * @param numbers The map of numbers to objects, or <code>null</code> for nothing.
      */