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 2017/07/22 21:35:40 UTC

svn commit: r1802711 - /pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/PDFStreamParser.java

Author: tilman
Date: Sat Jul 22 21:35:40 2017
New Revision: 1802711

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

Modified:
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/PDFStreamParser.java

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/PDFStreamParser.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/PDFStreamParser.java?rev=1802711&r1=1802710&r2=1802711&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/PDFStreamParser.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/PDFStreamParser.java Sat Jul 22 21:35:40 2017
@@ -103,8 +103,8 @@ public class PDFStreamParser extends Bas
     }
 
     /**
-     * This will parse the tokens in the stream.  This will close the
-     * stream when it is finished parsing.
+     * This will parse all the tokens in the stream. This will close the stream when it is finished
+     * parsing. You can then access these with {@link #getTokens() getTokens()}.
      *
      * @throws IOException If there is an error while parsing the stream.
      */
@@ -118,7 +118,7 @@ public class PDFStreamParser extends Bas
     }
 
     /**
-     * This will get the tokens that were parsed from the stream.
+     * This will get the tokens that were parsed from the stream by the {@link #parse() parse()} method.
      *
      * @return All of the tokens in the stream.
      */