Author: lehmi
Date: Sat Nov 5 00:42:08 2022
New Revision: 1905072
URL: http://svn.apache.org/viewvc?rev=1905072&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/CFFEncoding.java
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFFont.java
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFParser.java
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFType1Font.java
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CIDKeyedType2CharString.java
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CharStringCommand.java
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/DataInput.java
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/FDSelect.java
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/Type2CharString.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=1905072&r1=1905071&r2=1905072&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 Sat
Nov 5 00:42:08 2022
@@ -59,6 +59,7 @@ public interface FontBoxFont
/**
* Returns the path for the character with the given name.
*
+ * @param name PostScript glyph name
* @return glyph path
* @throws IOException if the path could not be read
*/
@@ -67,6 +68,7 @@ public interface FontBoxFont
/**
* Returns the advance width for the character with the given name.
*
+ * @param name PostScript glyph name
* @return glyph advance width
* @throws IOException if the path could not be read
*/
Modified:
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFEncoding.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFEncoding.java?rev=1905072&r1=1905071&r2=1905072&view=diff
==============================================================================
--- pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFEncoding.java
(original)
+++ pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFEncoding.java
Sat Nov 5 00:42:08 2022
@@ -35,8 +35,11 @@ public abstract class CFFEncoding extend
/**
* Adds a new code/SID combination to the encoding.
+ *
* @param code the given code
* @param sid the given SID
+ * @param name glyph name
+ *
*/
public void add(int code, int sid, String name)
{
@@ -45,6 +48,10 @@ public abstract class CFFEncoding extend
/**
* For use by subclasses only.
+ *
+ * @param code the given code
+ * @param sid the given SID
+ *
*/
protected void add(int code, int sid)
{
Modified: pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFFont.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFFont.java?rev=1905072&r1=1905071&r2=1905072&view=diff
==============================================================================
--- pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFFont.java
(original)
+++ pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFFont.java Sat
Nov 5 00:42:08 2022
@@ -150,6 +150,10 @@ public abstract class CFFFont implements
/**
* Returns the CFF data.
+ *
+ * @return the cff data as byte array
+ *
+ * @throws IOException if the data could not be read
*/
public byte[] getData() throws IOException
{
@@ -158,6 +162,8 @@ public abstract class CFFFont implements
/**
* Returns the number of charstrings in the font.
+ *
+ * @return the number of charstrings
*/
public int getNumCharStrings()
{
@@ -188,6 +194,9 @@ public abstract class CFFFont implements
* Returns the Type 2 charstring for the given CID.
*
* @param cidOrGid CID for CIFFont, or GID for Type 1 font
+ *
+ * @return the Type2 charstring of the given cid/gid
+ *
* @throws IOException if the charstring could not be read
*/
public abstract Type2CharString getType2CharString(int cidOrGid) throws
IOException;
Modified:
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFParser.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFParser.java?rev=1905072&r1=1905071&r2=1905072&view=diff
==============================================================================
--- pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFParser.java
(original)
+++ pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFParser.java
Sat Nov 5 00:42:08 2022
@@ -59,6 +59,8 @@ public class CFFParser
{
/**
* Returns the source bytes. May be called more than once.
+ *
+ * @return the source data as byte array
*/
byte[] getBytes() throws IOException;
}
@@ -81,7 +83,7 @@ public class CFFParser
/**
* Parse CFF font using a RandomAccessRead as input.
*
- * @param randomAccessRead
+ * @param randomAccessRead the source to be parsed
* @return the parsed CFF fonts
* @throws IOException If there is an error reading from the stream
*/
@@ -105,7 +107,7 @@ public class CFFParser
/**
* Parse CFF font using a DataInput as input.
*
- * @param input
+ * @param input the source to be parsed
* @return the parsed CFF fonts
* @throws IOException If there is an error reading from the stream
*/
Modified:
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFType1Font.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFType1Font.java?rev=1905072&r1=1905071&r2=1905072&view=diff
==============================================================================
--- pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFType1Font.java
(original)
+++ pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CFFType1Font.java
Sat Nov 5 00:42:08 2022
@@ -83,6 +83,8 @@ public class CFFType1Font extends CFFFon
* Returns the Type 1 charstring for the given PostScript glyph name.
*
* @param name PostScript glyph name
+ * @return Type1 charstring of the given PostScript glyph name
+ *
* @throws IOException if the charstring could not be read
*/
public Type1CharString getType1CharString(String name) throws IOException
Modified:
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CIDKeyedType2CharString.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CIDKeyedType2CharString.java?rev=1905072&r1=1905071&r2=1905072&view=diff
==============================================================================
---
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CIDKeyedType2CharString.java
(original)
+++
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CIDKeyedType2CharString.java
Sat Nov 5 00:42:08 2022
@@ -50,6 +50,8 @@ public class CIDKeyedType2CharString ext
/**
* Returns the CID (character id) of this charstring.
+ *
+ * @return the CID of this charstring
*/
public int getCID()
{
Modified:
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CharStringCommand.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CharStringCommand.java?rev=1905072&r1=1905071&r2=1905072&view=diff
==============================================================================
---
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CharStringCommand.java
(original)
+++
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/CharStringCommand.java
Sat Nov 5 00:42:08 2022
@@ -147,6 +147,7 @@ public class CharStringCommand
* Get an instance of the CharStringCommand represented by the given value.
*
* @param b0 value
+ * @return CharStringCommand represented by the given value
*/
public static CharStringCommand getInstance(int b0)
{
@@ -159,6 +160,8 @@ public class CharStringCommand
*
* @param b0 value1
* @param b1 value2
+ *
+ * @return CharStringCommand represented by the given two values
*/
public static CharStringCommand getInstance(int b0, int b1)
{
@@ -170,6 +173,8 @@ public class CharStringCommand
* Get an instance of the CharStringCommand represented by the given array.
*
* @param values array of values
+ *
+ * @rerturn CharStringCommand represented by the given values
*/
public static CharStringCommand getInstance(int[] values)
{
Modified:
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/DataInput.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/DataInput.java?rev=1905072&r1=1905071&r2=1905072&view=diff
==============================================================================
--- pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/DataInput.java
(original)
+++ pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/DataInput.java
Sat Nov 5 00:42:08 2022
@@ -27,14 +27,18 @@ public interface DataInput
{
/**
- * Determines if there are any bytes left to read or not.
+ * Determines if there are any bytes left to read or not.
+ *
* @return true if there are any bytes left to read
+ * @throws IOException if an error occurs during reading
*/
public boolean hasRemaining() throws IOException;
/**
* Returns the current position.
+ *
* @return current position
+ * @throws IOException if an error occurs during reading
*/
public int getPosition() throws IOException;
Modified:
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/FDSelect.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/FDSelect.java?rev=1905072&r1=1905071&r2=1905072&view=diff
==============================================================================
--- pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/FDSelect.java
(original)
+++ pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/FDSelect.java Sat
Nov 5 00:42:08 2022
@@ -23,6 +23,8 @@ public interface FDSelect
* Returns the Font DICT index for the given GID.
*
* @param gid GID
+ *
+ * @return the font dictionary index of the given GID
*/
public abstract int getFDIndex(int gid);
-}
+}
\ No newline at end of file
Modified:
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/Type2CharString.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/Type2CharString.java?rev=1905072&r1=1905071&r2=1905072&view=diff
==============================================================================
---
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/Type2CharString.java
(original)
+++
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/Type2CharString.java
Sat Nov 5 00:42:08 2022
@@ -60,6 +60,8 @@ public class Type2CharString extends Typ
/**
* Return the GID (glyph id) of this charstring.
+ *
+ * @return the GID of this charstring
*/
public int getGID()
{
