svn commit: r1905071 - in /pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox: FontBoxFont.java cff/CFFCIDFont.java cff/CFFCharset.java

[lehmi]

Author: lehmi
Date: Fri Nov  4 18:58:48 2022
New Revision: 1905071

URL: http://svn.apache.org/viewvc?rev=1905071&view=rev
Log:
PDFBOX-4892: fix javadoc

Modified:
    pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/FontBoxFont.java
    pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFCIDFont.java
    pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFCharset.java

Modified: pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/FontBoxFont.java
URL: 
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/FontBoxFont.java?rev=1905071&r1=1905070&r2=1905071&view=diff
==============================================================================
--- pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/FontBoxFont.java 
(original)
+++ pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/FontBoxFont.java Fri 
Nov  4 18:58:48 2022
@@ -31,16 +31,28 @@ public interface FontBoxFont
 {
     /**
      * The PostScript name of the font.
+     * 
+     * @return the postscript of the font or null
+     * 
+     * @throws IOException if something went wrong when accessing the font data
      */
     String getName() throws IOException;
     
     /**
      * Returns the font's bounding box in PostScript units.
+     *
+     * @return the bounding box of the font
+     * 
+     * @throws IOException if something went wrong when accessing the font data
      */
     BoundingBox getFontBBox() throws IOException;
 
     /**
      * Returns the FontMatrix in PostScript units.
+     * 
+     * @return the font matrix
+     * 
+     * @throws IOException if something went wrong when accessing the font data
      */
     List<Number> getFontMatrix() throws IOException;
 
@@ -64,6 +76,10 @@ public interface FontBoxFont
      * Returns true if the font contains the given glyph.
      * 
      * @param name PostScript glyph name
+     * 
+     * @return true if the font contains a glyph with the given name, 
otherwise false
+     * 
+     * @throws IOException if something went wrong when accessing the font data
      */
     boolean hasGlyph(String name) throws IOException;
 }

Modified: 
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFCIDFont.java
URL: 
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFCIDFont.java?rev=1905071&r1=1905070&r2=1905071&view=diff
==============================================================================
--- pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFCIDFont.java 
(original)
+++ pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFCIDFont.java 
Fri Nov  4 18:58:48 2022
@@ -50,7 +50,8 @@ public class CFFCIDFont extends CFFFont
 
     /**
      * Returns the registry value.
-     * * @return the registry
+     * 
+     * @return the registry
      */
     public String getRegistry() 
     {

Modified: 
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFCharset.java
URL: 
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFCharset.java?rev=1905071&r1=1905070&r2=1905071&view=diff
==============================================================================
--- pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFCharset.java 
(original)
+++ pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFCharset.java 
Fri Nov  4 18:58:48 2022
@@ -35,6 +35,7 @@ public interface CFFCharset
      *
      * @param gid GID
      * @param sid SID
+     * @param name the postscript name of the glyph
      */
     public abstract void addSID(int gid, int sid, String name);