svn commit: r1704707 - /pdfbox/branches/1.8/fontbox/src/main/java/org/apache/fontbox/ttf/AbstractTTFParser.java

[ti...@apache.org]

Author: tilman
Date: Tue Sep 22 19:47:29 2015
New Revision: 1704707

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

Modified:
    pdfbox/branches/1.8/fontbox/src/main/java/org/apache/fontbox/ttf/AbstractTTFParser.java

Modified: pdfbox/branches/1.8/fontbox/src/main/java/org/apache/fontbox/ttf/AbstractTTFParser.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/fontbox/src/main/java/org/apache/fontbox/ttf/AbstractTTFParser.java?rev=1704707&r1=1704706&r2=1704707&view=diff
==============================================================================
--- pdfbox/branches/1.8/fontbox/src/main/java/org/apache/fontbox/ttf/AbstractTTFParser.java (original)
+++ pdfbox/branches/1.8/fontbox/src/main/java/org/apache/fontbox/ttf/AbstractTTFParser.java Tue Sep 22 19:47:29 2015
@@ -83,14 +83,15 @@ abstract class AbstractTTFParser
     }
     
     /**
-     * Parse a file and get a true type font.
-     * @param ttfData The TTF data to parse.
+     * Parse an input stream and return a TrueType font.
+     *
+     * @param inputStream The TTF data stream to parse from. It will be closed before returning.
      * @return A true type font.
      * @throws IOException If there is an error parsing the true type font.
      */
-    public TrueTypeFont parseTTF( InputStream ttfData ) throws IOException
+    public TrueTypeFont parseTTF(InputStream inputStream) throws IOException
     {
-        return parseTTF( new MemoryTTFDataStream( ttfData ));
+        return parseTTF(new MemoryTTFDataStream(inputStream));
     }
     
     /**