svn commit: r1704709 - /pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/TTFParser.java

[ti...@apache.org]

Author: tilman
Date: Tue Sep 22 19:49:06 2015
New Revision: 1704709

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

Modified:
    pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/TTFParser.java

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