Author: lehmi
Date: Sat Nov 5 10:19:19 2022
New Revision: 1905078
URL: http://svn.apache.org/viewvc?rev=1905078&view=rev
Log:
PDFBOX-4892: fix javadoc
Modified:
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/Type1CharStringParser.java
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cmap/CodespaceRange.java
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/CFFTable.java
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/CmapTable.java
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/GlyphSubstitutionTable.java
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/GlyphTable.java
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/HorizontalMetricsTable.java
Modified:
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/Type1CharStringParser.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/Type1CharStringParser.java?rev=1905078&r1=1905077&r2=1905078&view=diff
==============================================================================
---
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/Type1CharStringParser.java
(original)
+++
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cff/Type1CharStringParser.java
Sat Nov 5 10:19:19 2022
@@ -64,6 +64,7 @@ public class Type1CharStringParser
*
* @param bytes the given mapping as byte array
* @param subrs list of local subroutines
+ * @param glyphName name of the current glyph
* @return the Type1 sequence
* @throws IOException if an error occurs during reading
*/
Modified:
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cmap/CodespaceRange.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cmap/CodespaceRange.java?rev=1905078&r1=1905077&r2=1905078&view=diff
==============================================================================
---
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cmap/CodespaceRange.java
(original)
+++
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/cmap/CodespaceRange.java
Sat Nov 5 10:19:19 2022
@@ -29,14 +29,14 @@ public class CodespaceRange
/**
* Creates a new instance of CodespaceRange. The length of both arrays has
to be the same.<br>
- * For one byte ranges startBytes and endBytes define a linear range of
values. Double byte values define a rectangular
- * range not a linear range. Examples: <br>
+ * For one byte ranges startBytes and endBytes define a linear range of
values. Double byte values define a
+ * rectangular range not a linear range. Examples: <br>
* <00> <20> defines a linear range from 0x00 up to 0x20.<br>
- * <8140> to <9FFC> defines a rectangular range. The high byte
has to be within 0x81 and 0x9F and the low
- * byte has to be within 0x40 and 0xFC
+ * <8140> to <9FFC> defines a rectangular range. The high byte
has to be within 0x81 and 0x9F and the
+ * low byte has to be within 0x40 and 0xFC
*
- * @param startBytes
- * @param endBytes
+ * @param startBytes start of the range
+ * @param endBytes start of the range
*/
public CodespaceRange(byte[] startBytes, byte[] endBytes)
{
@@ -72,6 +72,10 @@ public class CodespaceRange
/**
* Returns true if the given code bytes match this codespace range.
+ *
+ * @param code the code bytes to be matched
+ *
+ * @return true if the given code bytes match this codespace range
*/
public boolean matches(byte[] code)
{
@@ -80,6 +84,11 @@ public class CodespaceRange
/**
* Returns true if the given number of code bytes match this codespace
range.
+ *
+ * @param code the code bytes to be matched
+ * @param codeLen the code length to be used for matching
+ *
+ * @return true if the given number of code bytes match this codespace
range
*/
public boolean isFullMatch(byte[] code, int codeLen)
{
Modified:
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/CFFTable.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/CFFTable.java?rev=1905078&r1=1905077&r2=1905078&view=diff
==============================================================================
--- pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/CFFTable.java
(original)
+++ pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/CFFTable.java Sat
Nov 5 10:19:19 2022
@@ -58,6 +58,8 @@ public class CFFTable extends TTFTable
/**
* Returns the CFF font, which is a compact representation of a PostScript
Type 1, or CIDFont
+ *
+ * @return the associated CFF font
*/
public CFFFont getFont()
{
Modified:
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/CmapTable.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/CmapTable.java?rev=1905078&r1=1905077&r2=1905078&view=diff
==============================================================================
--- pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/CmapTable.java
(original)
+++ pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/CmapTable.java
Sat Nov 5 10:19:19 2022
@@ -107,6 +107,11 @@ public class CmapTable extends TTFTable
/**
* Returns the subtable, if any, for the given platform and encoding.
+ *
+ * @param platformId the ID of the given platform
+ * @param platformEncodingId the ID of the given encoding
+ *
+ * @return the subtable, if any, or null
*/
public CmapSubtable getSubtable(int platformId, int platformEncodingId)
{
Modified:
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/GlyphSubstitutionTable.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/GlyphSubstitutionTable.java?rev=1905078&r1=1905077&r2=1905078&view=diff
==============================================================================
---
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/GlyphSubstitutionTable.java
(original)
+++
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/GlyphSubstitutionTable.java
Sat Nov 5 10:19:19 2022
@@ -635,17 +635,17 @@ public class GlyphSubstitutionTable exte
}
/**
- * Apply glyph substitutions to the supplied gid. The applicable
substitutions are determined by
- * the {@code scriptTags} which indicate the language of the gid, and by
the list of
- * {@code enabledFeatures}.
+ * Apply glyph substitutions to the supplied gid. The applicable
substitutions are determined by the
+ * {@code scriptTags} which indicate the language of the gid, and by the
list of {@code enabledFeatures}.
*
- * To ensure that a single gid isn't mapped to multiple substitutions,
subsequent invocations
- * with the same gid will return the same result as the first, regardless
of script or enabled
- * features.
+ * To ensure that a single gid isn't mapped to multiple substitutions,
subsequent invocations with the same gid will
+ * return the same result as the first, regardless of script or enabled
features.
*
* @param gid GID
* @param scriptTags Script tags applicable to the gid (see {@link
OpenTypeScript})
* @param enabledFeatures list of features to apply
+ *
+ * @return the id of the glyph substituion
*/
public int getSubstitution(int gid, String[] scriptTags, List<String>
enabledFeatures)
{
@@ -675,13 +675,14 @@ public class GlyphSubstitutionTable exte
}
/**
- * For a substitute-gid (obtained from {@link #getSubstitution(int,
String[], List)}), retrieve
- * the original gid.
+ * For a substitute-gid (obtained from {@link #getSubstitution(int,
String[], List)}), retrieve the original gid.
*
- * Only gids previously substituted by this instance can be
un-substituted. If you are trying to
- * unsubstitute before you substitute, something is wrong.
+ * Only gids previously substituted by this instance can be
un-substituted. If you are trying to unsubstitute before
+ * you substitute, something is wrong.
*
* @param sgid Substitute GID
+ *
+ * @return the original gid of a substitute-gid
*/
public int getUnsubstitution(int sgid)
{
Modified:
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/GlyphTable.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/GlyphTable.java?rev=1905078&r1=1905077&r2=1905078&view=diff
==============================================================================
--- pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/GlyphTable.java
(original)
+++ pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/GlyphTable.java
Sat Nov 5 10:19:19 2022
@@ -102,6 +102,9 @@ public class GlyphTable extends TTFTable
* Returns the data for the glyph with the given GID.
*
* @param gid GID
+ *
+ * @return data of the glyph with the given GID or null
+ *
* @throws IOException if the font cannot be read
*/
public GlyphData getGlyph(int gid) throws IOException
Modified:
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/HorizontalMetricsTable.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/HorizontalMetricsTable.java?rev=1905078&r1=1905077&r2=1905078&view=diff
==============================================================================
---
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/HorizontalMetricsTable.java
(original)
+++
pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/HorizontalMetricsTable.java
Sat Nov 5 10:19:19 2022
@@ -99,6 +99,8 @@ public class HorizontalMetricsTable exte
* Returns the advance width for the given GID.
*
* @param gid GID
+ *
+ * @return the advance width of the given GID
*/
public int getAdvanceWidth(int gid)
{
@@ -122,6 +124,8 @@ public class HorizontalMetricsTable exte
* Returns the left side bearing for the given GID.
*
* @param gid GID
+ *
+ * @return the left side bearing of the given GID
*/
public int getLeftSideBearing(int gid)
{
