Author: lehmi
Date: Tue Nov 8 07:20:56 2022
New Revision: 1905144
URL: http://svn.apache.org/viewvc?rev=1905144&view=rev
Log:
PDFBOX-4892: fix javadoc
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDCIDFontType0.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDPanose.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDTrueTypeFont.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType0Font.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType3Font.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/Standard14Fonts.java
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDCIDFontType0.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDCIDFontType0.java?rev=1905144&r1=1905143&r2=1905144&view=diff
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDCIDFontType0.java
(original)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDCIDFontType0.java
Tue Nov 8 07:20:56 2022
@@ -276,10 +276,12 @@ public class PDCIDFontType0 extends PDCI
}
/**
- * Returns the Type 2 charstring for the given CID, or null if the
substituted font does not
- * contain Type 2 charstrings.
+ * Returns the Type 2 charstring for the given CID, or null if the
substituted font does not contain Type 2
+ * charstrings.
*
* @param cid CID
+ * @return the Type 2 charstring for the given CID or null
+ *
* @throws IOException if the charstring could not be read
*/
public Type2CharString getType2CharString(int cid) throws IOException
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDPanose.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDPanose.java?rev=1905144&r1=1905143&r2=1905144&view=diff
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDPanose.java
(original)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDPanose.java
Tue Nov 8 07:20:56 2022
@@ -40,10 +40,13 @@ public class PDPanose
}
/**
- * The font family class and subclass ID bytes, given in the sFamilyClass
field of the
- * âOS/2â table in a TrueType font.
+ * The font family class and subclass ID bytes, given in the sFamilyClass
field of the âOS/2â table in a TrueType
+ * font.
*
- * @see <a
href="http://www.microsoft.com/typography/otspec/ibmfc.htm";>http://www.microsoft.com/typography/otspec/ibmfc.htm</a>
+ * @see <a href=
+ *
"http://www.microsoft.com/typography/otspec/ibmfc.htm";>http://www.microsoft.com/typography/otspec/ibmfc.htm</a>
+ *
+ * @return font family class and subclass ID bytes
*/
public int getFamilyClass()
{
@@ -54,6 +57,8 @@ public class PDPanose
* Ten bytes for the PANOSE classification number for the font.
*
* @see <a
href="http://www.monotype.com/services/pan1";>http://www.monotype.com/services/pan1</a>
+ *
+ * @return the PANOSE classification number
*/
public PDPanoseClassification getPanose()
{
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDTrueTypeFont.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDTrueTypeFont.java?rev=1905144&r1=1905143&r2=1905144&view=diff
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDTrueTypeFont.java
(original)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDTrueTypeFont.java
Tue Nov 8 07:20:56 2022
@@ -93,6 +93,8 @@ public class PDTrueTypeFont extends PDSi
* Creates a new TrueType font from a Font dictionary.
*
* @param fontDictionary The font dictionary according to the PDF
specification.
+ *
+ * @throws IOException if the font could not be created
*/
public PDTrueTypeFont(COSDictionary fontDictionary) throws IOException
{
@@ -242,6 +244,8 @@ public class PDTrueTypeFont extends PDSi
/**
* Returns the PostScript name of the font.
+ *
+ * @return the PostScript name of the font
*/
public final String getBaseFont()
{
@@ -345,6 +349,8 @@ public class PDTrueTypeFont extends PDSi
/**
* Returns the embedded or substituted TrueType font.
+ *
+ * @return the embedded or substituted TrueType font
*/
public TrueTypeFont getTrueTypeFont()
{
@@ -430,6 +436,10 @@ public class PDTrueTypeFont extends PDSi
/**
* Inverts the font's code -> GID mapping. Any duplicate (GID ->
code) mappings will be lost.
+ *
+ * @return the GID for the given code
+ *
+ * @throws IOException if the data could not be read
*/
protected Map<Integer, Integer> getGIDToCode() throws IOException
{
@@ -565,7 +575,7 @@ public class PDTrueTypeFont extends PDSi
*
* @param code character code
* @return GID (glyph index)
- * @throws java.io.IOException
+ * @throws IOException if the data could not be read
*/
public int codeToGID(int code) throws IOException
{
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType0Font.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType0Font.java?rev=1905144&r1=1905143&r2=1905144&view=diff
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType0Font.java
(original)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType0Font.java
Tue Nov 8 07:20:56 2022
@@ -408,6 +408,8 @@ public class PDType0Font extends PDFont
/**
* Returns the PostScript name of the font.
+ *
+ * @return the PostScript name of the font
*/
public String getBaseFont()
{
@@ -416,6 +418,8 @@ public class PDType0Font extends PDFont
/**
* Returns the descendant font.
+ *
+ * @return the descendant font
*/
public PDCIDFont getDescendantFont()
{
@@ -424,6 +428,8 @@ public class PDType0Font extends PDFont
/**
* Returns the font's CMap.
+ *
+ * @return the font's CMap
*/
public CMap getCMap()
{
@@ -432,6 +438,8 @@ public class PDType0Font extends PDFont
/**
* Returns the font's UCS2 CMap, only present this font uses a predefined
CMap.
+ *
+ * @return the font's UCS2 CMap if present
*/
public CMap getCMapUCS2()
{
@@ -621,7 +629,7 @@ public class PDType0Font extends PDFont
* Returns the CID for the given character code. If not found then CID 0
is returned.
*
* @param code character code
- * @return CID
+ * @return CID for the given character code
*/
public int codeToCID(int code)
{
@@ -632,7 +640,9 @@ public class PDType0Font extends PDFont
* Returns the GID for the given character code.
*
* @param code character code
- * @return GID
+ * @return GID for the given character code
+ *
+ * @throws IOException if the data could not be read
*/
public int codeToGID(int code) throws IOException
{
@@ -681,16 +691,32 @@ public class PDType0Font extends PDFont
return descendantFont.hasGlyph(code);
}
+ /**
+ * Returns the GSubData if present.
+ *
+ * @return the GSubData if present
+ */
public GsubData getGsubData()
{
return gsubData;
}
+ /**
+ * Returns the encoded value for the given glyph ID.
+ *
+ * @param glyphId the ID of the glyph to be encoded
+ * @return the encoded glyph ID
+ */
public byte[] encodeGlyphId(int glyphId)
{
return descendantFont.encodeGlyphId(glyphId);
}
+ /**
+ * Returns the CMap lookup table if present.
+ *
+ * @return the CMap lookup table if present
+ */
public CmapLookup getCmapLookup()
{
return cmapLookup;
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType3Font.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType3Font.java?rev=1905144&r1=1905143&r2=1905144&view=diff
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType3Font.java
(original)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType3Font.java
Tue Nov 8 07:20:56 2022
@@ -63,6 +63,8 @@ public class PDType3Font extends PDSimpl
* Constructor.
*
* @param fontDictionary The font dictionary according to the PDF
specification.
+ *
+ * @throws IOException if the font could not be created
*/
public PDType3Font(COSDictionary fontDictionary) throws IOException
{
@@ -74,6 +76,8 @@ public class PDType3Font extends PDSimpl
*
* @param fontDictionary The font dictionary according to the PDF
specification.
* @param resourceCache Resource cache, can be null.
+ *
+ * @throws IOException if the font could not be created
*/
public PDType3Font(COSDictionary fontDictionary, ResourceCache
resourceCache) throws IOException
{
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/Standard14Fonts.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/Standard14Fonts.java?rev=1905144&r1=1905143&r2=1905144&view=diff
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/Standard14Fonts.java
(original)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/Standard14Fonts.java
Tue Nov 8 07:20:56 2022
@@ -217,6 +217,8 @@ public final class Standard14Fonts
/**
* Returns the set of known font names, including aliases.
+ *
+ * @return the set of known font names
*/
public static Set<String> getNames()
{
@@ -263,6 +265,8 @@ public final class Standard14Fonts
* @param baseName name of the standard 14 font
* @param glyphName name of glyph
* @return the mapped font
+ *
+ * @throws IOException if the data could not be read
*/
public static GeneralPath getGlyphPath(FontName baseName, String
glyphName) throws IOException
{
