svn commit: r1840252 - /pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNameTreeNode.java

[ti...@apache.org]

Author: tilman
Date: Thu Sep  6 17:51:46 2018
New Revision: 1840252

URL: http://svn.apache.org/viewvc?rev=1840252&view=rev
Log:
PDFBOX-4071: 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=1840252&r1=1840251&r2=1840252&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 Thu Sep  6 17:51:46 2018
@@ -246,12 +246,14 @@ public abstract class PDNameTreeNode<T e
     }
 
     /**
-     * This will return a map of names. The key will be a string, and the
-     * value will depend on where this class is being used.
+     * This will return a map of names on this level. The key will be a string,
+     * and the value will depend on where this class is being used.
+     *
+     * @return ordered map of COS objects or <code>null</code> if the dictionary
+     * contains no 'Names' entry on this level.
      *
-     * @return ordered map of cos objects or <code>null</code> if dictionary
-     *         contains no 'Names' entry
      * @throws IOException If there is an error while creating the sub types.
+     * @see #getKids()
      */
     public Map<String, T> getNames() throws IOException
     {