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 2021/04/21 16:31:05 UTC
svn commit: r1889066 -
/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNameTreeNode.java
Author: tilman
Date: Wed Apr 21 16:31:05 2021
New Revision: 1889066
URL: http://svn.apache.org/viewvc?rev=1889066&view=rev
Log:
PDFBOX-5164: improve javadoc
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNameTreeNode.java
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNameTreeNode.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNameTreeNode.java?rev=1889066&r1=1889065&r2=1889066&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNameTreeNode.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNameTreeNode.java Wed Apr 21 16:31:05 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 )
{
@@ -302,7 +304,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.
*/