You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by le...@apache.org on 2022/11/09 06:36:53 UTC
svn commit: r1905178 - in /pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel: font/ font/encoding/ graphics/ graphics/color/
Author: lehmi
Date: Wed Nov 9 06:36:53 2022
New Revision: 1905178
URL: http://svn.apache.org/viewvc?rev=1905178&view=rev
Log:
PDFBOX-4892: fix javadoc
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType1CFont.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/DictionaryEncoding.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/Encoding.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/GlyphList.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/Type1Encoding.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/PDXObject.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDColor.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDColorSpace.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDDeviceCMYK.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDDeviceN.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDIndexed.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDPattern.java
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType1CFont.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType1CFont.java?rev=1905178&r1=1905177&r2=1905178&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType1CFont.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType1CFont.java Wed Nov 9 06:36:53 2022
@@ -147,6 +147,8 @@ public class PDType1CFont extends PDSimp
/**
* Returns the PostScript name of the font.
+ *
+ * @return the PostScript name of the font
*/
public final String getBaseFont()
{
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/DictionaryEncoding.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/DictionaryEncoding.java?rev=1905178&r1=1905177&r2=1905178&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/DictionaryEncoding.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/DictionaryEncoding.java Wed Nov 9 06:36:53 2022
@@ -39,8 +39,8 @@ public class DictionaryEncoding extends
/**
* Creates a new DictionaryEncoding for embedding.
*
- * @param baseEncoding
- * @param differences
+ * @param baseEncoding the base encoding of this encoding
+ * @param differences the differences of this encoding with regard to the base encoding
*/
public DictionaryEncoding(COSName baseEncoding, COSArray differences)
{
@@ -156,6 +156,8 @@ public class DictionaryEncoding extends
/**
* Returns the base encoding. Will be null for Type 3 fonts.
+ *
+ * @return the base encoding or null
*/
public Encoding getBaseEncoding()
{
@@ -164,6 +166,8 @@ public class DictionaryEncoding extends
/**
* Returns the Differences array.
+ *
+ * @return a map containing all differences
*/
public Map<Integer, String> getDifferences()
{
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/Encoding.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/Encoding.java?rev=1905178&r1=1905177&r2=1905178&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/Encoding.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/Encoding.java Wed Nov 9 06:36:53 2022
@@ -138,6 +138,7 @@ public abstract class Encoding implement
* Determines if the encoding has a mapping for the given name value.
*
* @param name PostScript glyph name
+ * @return true if the encoding has a mapping for the given name value
*/
public boolean contains(String name)
{
@@ -148,6 +149,8 @@ public abstract class Encoding implement
* Determines if the encoding has a mapping for the given code value.
*
* @param code character code
+ * @return if the encoding has a mapping for the given code value
+ *
*/
public boolean contains(int code)
{
@@ -172,6 +175,8 @@ public abstract class Encoding implement
/**
* Returns the name of this encoding.
+ *
+ * @return the name of the encoding
*/
public abstract String getEncodingName();
}
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/GlyphList.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/GlyphList.java?rev=1905178&r1=1905177&r2=1905178&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/GlyphList.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/GlyphList.java Wed Nov 9 06:36:53 2022
@@ -65,6 +65,8 @@ public final class GlyphList
/**
* Returns the Adobe Glyph List (AGL).
+ *
+ * @return the Adobe glyph list
*/
public static GlyphList getAdobeGlyphList()
{
@@ -73,6 +75,8 @@ public final class GlyphList
/**
* Returns the Zapf Dingbats glyph list.
+ *
+ * @return the Zapf Dingbats glyph list
*/
public static GlyphList getZapfDingbats()
{
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/Type1Encoding.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/Type1Encoding.java?rev=1905178&r1=1905177&r2=1905178&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/Type1Encoding.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/encoding/Type1Encoding.java Wed Nov 9 06:36:53 2022
@@ -31,6 +31,7 @@ public class Type1Encoding extends Encod
* Creates an encoding from the given FontBox encoding.
*
* @param encoding FontBox encoding
+ * @return the encoding created from the given FontBox encoding
*/
public static Type1Encoding fromFontBox(org.apache.fontbox.encoding.Encoding encoding)
{
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/PDXObject.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/PDXObject.java?rev=1905178&r1=1905177&r2=1905178&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/PDXObject.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/PDXObject.java Wed Nov 9 06:36:53 2022
@@ -45,7 +45,7 @@ public class PDXObject implements COSObj
* Creates a new XObject instance of the appropriate type for the COS stream.
*
* @param base The stream which is wrapped by this XObject.
- * @param resources
+ * @param resources the resources of this XObject
* @return A new XObject instance.
* @throws java.io.IOException if there is an error creating the XObject.
*/
@@ -91,8 +91,9 @@ public class PDXObject implements COSObj
/**
* Creates a new XObject from the given stream and subtype.
+ *
* @param stream The stream to read.
- * @param subtype
+ * @param subtype the subtype to be used for this XObject
*/
protected PDXObject(COSStream stream, COSName subtype)
{
@@ -104,8 +105,9 @@ public class PDXObject implements COSObj
/**
* Creates a new XObject from the given stream and subtype.
+ *
* @param stream The stream to read.
- * @param subtype
+ * @param subtype the subtype to be used for this XObject
*/
protected PDXObject(PDStream stream, COSName subtype)
{
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDColor.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDColor.java?rev=1905178&r1=1905177&r2=1905178&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDColor.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDColor.java Wed Nov 9 06:36:53 2022
@@ -201,6 +201,8 @@ public final class PDColor
/**
* Returns the color space in which this color value is defined.
+ *
+ * @return the color space in which this color value is defined
*/
public PDColorSpace getColorSpace()
{
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDColorSpace.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDColorSpace.java?rev=1905178&r1=1905177&r2=1905178&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDColorSpace.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDColorSpace.java Wed Nov 9 06:36:53 2022
@@ -310,14 +310,16 @@ public abstract class PDColorSpace imple
/**
* Returns the image in this colorspace or null. No conversion is performed.
*
- * For special colorspaces like PDSeparation the image is returned in the gray colorspace.
- * For undefined colorspaces like DeviceCMYK/DeviceRGB and DeviceGray null is returned.
+ * For special colorspaces like PDSeparation the image is returned in the gray colorspace. For undefined colorspaces
+ * like DeviceCMYK/DeviceRGB and DeviceGray null is returned.
*
* You can always fallback to {@link #toRGBImage(WritableRaster)} if this returns null.
*
* @param raster the source raster
- * @return an buffered image in this colorspace. Or null if it is not possible to extract
- * that image with the original colorspace without conversion.
+ * @return an buffered image in this colorspace. Or null if it is not possible to extract that image with the
+ * original colorspace without conversion.
+ *
+ * @throws IOException if the image conversion fails
*/
public abstract BufferedImage toRawImage(WritableRaster raster) throws IOException;
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDDeviceCMYK.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDDeviceCMYK.java?rev=1905178&r1=1905177&r2=1905178&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDDeviceCMYK.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDDeviceCMYK.java Wed Nov 9 06:36:53 2022
@@ -57,6 +57,8 @@ public class PDDeviceCMYK extends PDDevi
/**
* Lazy load the ICC profile, because it's slow.
+ *
+ * @throws IOException if the ICC profile could not be initialized
*/
protected void init() throws IOException
{
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDDeviceN.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDDeviceN.java?rev=1905178&r1=1905177&r2=1905178&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDDeviceN.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDDeviceN.java Wed Nov 9 06:36:53 2022
@@ -80,7 +80,10 @@ public class PDDeviceN extends PDSpecial
/**
* Creates a new DeviceN color space from the given COS array.
+ *
* @param deviceN an array containing the color space information
+ *
+ * @throws IOException if the colorspace could not be created
*/
public PDDeviceN(COSArray deviceN) throws IOException
{
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDIndexed.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDIndexed.java?rev=1905178&r1=1905177&r2=1905178&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDIndexed.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDIndexed.java Wed Nov 9 06:36:53 2022
@@ -69,8 +69,9 @@ public final class PDIndexed extends PDS
/**
* Creates a new indexed color space from the given PDF array.
+ *
* @param indexedArray the array containing the indexed parameters
- * @throws java.io.IOException
+ * @throws IOException if the colorspace could not be created
*/
public PDIndexed(COSArray indexedArray) throws IOException
{
@@ -79,9 +80,10 @@ public final class PDIndexed extends PDS
/**
* Creates a new indexed color space from the given PDF array.
+ *
* @param indexedArray the array containing the indexed parameters
* @param resources the resources, can be null. Allows to use its cache for the colorspace.
- * @throws java.io.IOException
+ * @throws IOException if the colorspace could not be created
*/
public PDIndexed(COSArray indexedArray, PDResources resources) throws IOException
{
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDPattern.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDPattern.java?rev=1905178&r1=1905177&r2=1905178&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDPattern.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDPattern.java Wed Nov 9 06:36:53 2022
@@ -129,6 +129,8 @@ public final class PDPattern extends PDS
/**
* Returns the underlying color space, if this is an uncolored tiling pattern, otherwise null.
+ *
+ * @return the underlying color space or null
*/
public PDColorSpace getUnderlyingColorSpace()
{