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 2015/07/02 01:20:02 UTC

svn commit: r1688753 - /pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/TrueTypeFont.java

Author: tilman
Date: Wed Jul  1 23:20:02 2015
New Revision: 1688753

URL: http://svn.apache.org/r1688753
Log:
PDFBOX-2576: fix javadoc

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

Modified: pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/TrueTypeFont.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/TrueTypeFont.java?rev=1688753&r1=1688752&r2=1688753&view=diff
==============================================================================
--- pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/TrueTypeFont.java (original)
+++ pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/TrueTypeFont.java Wed Jul  1 23:20:02 2015
@@ -107,6 +107,8 @@ public class TrueTypeFont implements Fon
 
     /**
      * Returns the war bytes of the given table.
+     * @param table the table to read.
+     * @throws IOException if there was an error accessing the table.
      */
     public synchronized byte[] getTableBytes(TTFTable table) throws IOException
     {
@@ -126,6 +128,7 @@ public class TrueTypeFont implements Fon
      * This will get the naming table for the true type font.
      * 
      * @return The naming table.
+     * @throws IOException if there was an error reading the table.
      */
     public synchronized NamingTable getNaming() throws IOException
     {
@@ -141,6 +144,7 @@ public class TrueTypeFont implements Fon
      * Get the postscript table for this TTF.
      * 
      * @return The postscript table.
+     * @throws IOException if there was an error reading the table.
      */
     public synchronized PostScriptTable getPostScript() throws IOException
     {
@@ -156,6 +160,7 @@ public class TrueTypeFont implements Fon
      * Get the OS/2 table for this TTF.
      * 
      * @return The OS/2 table.
+     * @throws IOException if there was an error reading the table.
      */
     public synchronized OS2WindowsMetricsTable getOS2Windows() throws IOException
     {
@@ -171,6 +176,7 @@ public class TrueTypeFont implements Fon
      * Get the maxp table for this TTF.
      * 
      * @return The maxp table.
+     * @throws IOException if there was an error reading the table.
      */
     public synchronized MaximumProfileTable getMaximumProfile() throws IOException
     {
@@ -186,6 +192,7 @@ public class TrueTypeFont implements Fon
      * Get the head table for this TTF.
      * 
      * @return The head table.
+     * @throws IOException if there was an error reading the table.
      */
     public synchronized HeaderTable getHeader() throws IOException
     {
@@ -201,6 +208,7 @@ public class TrueTypeFont implements Fon
      * Get the hhea table for this TTF.
      * 
      * @return The hhea table.
+     * @throws IOException if there was an error reading the table.
      */
     public synchronized HorizontalHeaderTable getHorizontalHeader() throws IOException
     {
@@ -216,6 +224,7 @@ public class TrueTypeFont implements Fon
      * Get the hmtx table for this TTF.
      * 
      * @return The hmtx table.
+     * @throws IOException if there was an error reading the table.
      */
     public synchronized HorizontalMetricsTable getHorizontalMetrics() throws IOException
     {
@@ -231,6 +240,7 @@ public class TrueTypeFont implements Fon
      * Get the loca table for this TTF.
      * 
      * @return The loca table.
+     * @throws IOException if there was an error reading the table.
      */
     public synchronized IndexToLocationTable getIndexToLocation() throws IOException
     {
@@ -246,6 +256,7 @@ public class TrueTypeFont implements Fon
      * Get the glyf table for this TTF.
      * 
      * @return The glyf table.
+     * @throws IOException if there was an error reading the table.
      */
     public synchronized GlyphTable getGlyph() throws IOException
     {
@@ -261,7 +272,8 @@ public class TrueTypeFont implements Fon
      * Get the "cmap" table for this TTF.
      * 
      * @return The "cmap" table.
-     */
+    * @throws IOException if there was an error reading the table.
+      */
     public synchronized CmapTable getCmap() throws IOException
     {
         CmapTable cmap = (CmapTable)tables.get( CmapTable.TAG );
@@ -276,6 +288,7 @@ public class TrueTypeFont implements Fon
      * Get the vhea table for this TTF.
      * 
      * @return The vhea table.
+     * @throws IOException if there was an error reading the table.
      */
     public synchronized VerticalHeaderTable getVerticalHeader() throws IOException
     {
@@ -291,6 +304,7 @@ public class TrueTypeFont implements Fon
      * Get the vmtx table for this TTF.
      * 
      * @return The vmtx table.
+     * @throws IOException if there was an error reading the table.
      */
     public synchronized VerticalMetricsTable getVerticalMetrics() throws IOException
     {
@@ -306,6 +320,7 @@ public class TrueTypeFont implements Fon
      * Get the VORG table for this TTF.
      * 
      * @return The VORG table.
+     * @throws IOException if there was an error reading the table.
      */
     public synchronized VerticalOriginTable getVerticalOrigin() throws IOException
     {
@@ -321,6 +336,7 @@ public class TrueTypeFont implements Fon
      * Get the "kern" table for this TTF.
      * 
      * @return The "kern" table.
+     * @throws IOException if there was an error reading the table.
      */
     public synchronized KerningTable getKerning() throws IOException
     {
@@ -367,6 +383,7 @@ public class TrueTypeFont implements Fon
      * Returns the number of glyphs (MaximuProfile.numGlyphs).
      * 
      * @return the number of glyphs
+     * @throws IOException if there was an error reading the table.
      */
     public int getNumberOfGlyphs() throws IOException
     {
@@ -390,6 +407,7 @@ public class TrueTypeFont implements Fon
      * Returns the units per EM (Header.unitsPerEm).
      * 
      * @return units per EM
+     * @throws IOException if there was an error reading the table.
      */
     public int getUnitsPerEm() throws IOException
     {
@@ -414,6 +432,7 @@ public class TrueTypeFont implements Fon
      * 
      * @param gid the GID
      * @return the width
+     * @throws IOException if there was an error reading the metrics table.
      */
     public int getAdvanceWidth(int gid) throws IOException
     {
@@ -434,6 +453,7 @@ public class TrueTypeFont implements Fon
      * 
      * @param gid the GID
      * @return the height
+     * @throws IOException if there was an error reading the metrics table.
      */
     public int getAdvanceHeight(int gid) throws IOException
     {
@@ -543,6 +563,7 @@ public class TrueTypeFont implements Fon
 
     /**
      * Returns the GID for the given PostScript name, if the "post" table is present.
+     * @param name the PostScript name.
      */
     public int nameToGID(String name) throws IOException
     {