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

[ti...@apache.org]

Author: tilman
Date: Wed Apr 21 16:31:01 2021
New Revision: 1889065

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

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

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNameTreeNode.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNameTreeNode.java?rev=1889065&r1=1889064&r2=1889065&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNameTreeNode.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNameTreeNode.java Wed Apr 21 16:31:01 2021
@@ -131,7 +131,9 @@ public abstract class PDNameTreeNode<T e
     /**
      * Set the children of this named tree.
      *
-     * @param kids The children of this named tree.
+     * @param kids The children of this named tree. These have to be in sorted order. Because of
+     * that, it is usually easier to call {@link setNames} with a map and pass a single element list
+     * here.
      */
     public void setKids( List<? extends PDNameTreeNode<T>> kids )
     {
@@ -305,7 +307,7 @@ public abstract class PDNameTreeNode<T e
 
     /**
      * Set the names 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 names map of names to objects, or <code>null</code> for nothing.
      */