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 2018/09/06 17:51:41 UTC

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

Author: tilman
Date: Thu Sep  6 17:51:41 2018
New Revision: 1840251

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

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

Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNameTreeNode.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNameTreeNode.java?rev=1840251&r1=1840250&r2=1840251&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNameTreeNode.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDNameTreeNode.java Thu Sep  6 17:51:41 2018
@@ -256,14 +256,15 @@ public class PDNameTreeNode implements C
         return retval;
     }
 
-
     /**
-     * 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 dictionary
-     *         contains no 'Names' entry
+     * @return ordered map of COS objects or <code>null</code> if the dictionary
+     * contains no 'Names' entry on this level.
+     * 
      * @throws IOException If there is an error while creating the sub types.
+     * @see #getKids()
      */
     public Map<String, COSObjectable> getNames() throws IOException
     {