Author: lehmi
Date: Fri Nov 11 07:21:20 2022
New Revision: 1905235
URL: http://svn.apache.org/viewvc?rev=1905235&view=rev
Log:
PDFBOX-4892: fix javadoc
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDExtendedGraphicsState.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDGraphicsState.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDSoftMask.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/RenderingMode.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDActionEmbeddedGoTo.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/PDAnnotation.java
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDExtendedGraphicsState.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDExtendedGraphicsState.java?rev=1905235&r1=1905234&r2=1905235&view=diff
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDExtendedGraphicsState.java
(original)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDExtendedGraphicsState.java
Fri Nov 11 07:21:20 2022
@@ -572,7 +572,7 @@ public class PDExtendedGraphicsState imp
/**
* Set the blending mode.
*
- * @param bm
+ * @param bm blend mode
*/
public void setBlendMode(BlendMode bm)
{
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDGraphicsState.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDGraphicsState.java?rev=1905235&r1=1905234&r2=1905235&view=diff
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDGraphicsState.java
(original)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDGraphicsState.java
Fri Nov 11 07:21:20 2022
@@ -280,7 +280,7 @@ public class PDGraphicsState implements
/**
* Sets the current soft mask
*
- * @param softMask
+ * @param softMask soft mask
*/
public void setSoftMask(PDSoftMask softMask)
{
@@ -300,7 +300,7 @@ public class PDGraphicsState implements
/**
* Sets the blend mode in the current graphics state
*
- * @param blendMode
+ * @param blendMode blend mode
* @throws IllegalArgumentException if blendMode is null.
*/
public void setBlendMode(BlendMode blendMode)
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDSoftMask.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDSoftMask.java?rev=1905235&r1=1905234&r2=1905235&view=diff
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDSoftMask.java
(original)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDSoftMask.java
Fri Nov 11 07:21:20 2022
@@ -41,6 +41,8 @@ public final class PDSoftMask implements
* Creates a new soft mask.
*
* @param dictionary SMask
+ *
+ * @return the newly created instance of PDSoftMask
*/
public static PDSoftMask create(COSBase dictionary)
{
@@ -98,6 +100,8 @@ public final class PDSoftMask implements
/**
* Returns the subtype of the soft mask (Alpha, Luminosity) - S entry
+ *
+ * @return the subtype of the soft mask
*/
public COSName getSubType()
{
@@ -112,7 +116,7 @@ public final class PDSoftMask implements
* Returns the G entry of the soft mask object
*
* @return form containing the transparency group
- * @throws IOException
+ * @throws IOException if the group could not be read
*/
public PDTransparencyGroup getGroup() throws IOException
{
@@ -133,6 +137,8 @@ public final class PDSoftMask implements
/**
* Returns the backdrop color.
+ *
+ * @return the backdrop color
*/
public COSArray getBackdropColor()
{
@@ -145,6 +151,8 @@ public final class PDSoftMask implements
/**
* Returns the transfer function.
+ *
+ * @return the transfer function
* @throws IOException If we are unable to create the PDFunction object.
*/
public PDFunction getTransferFunction() throws IOException
@@ -163,7 +171,7 @@ public final class PDSoftMask implements
/**
* Set the CTM that is valid at the time the ExtGState was activated.
*
- * @param ctm
+ * @param ctm the transformation matrix
*/
void setInitialTransformationMatrix(Matrix ctm)
{
@@ -173,6 +181,7 @@ public final class PDSoftMask implements
/**
* Returns the CTM at the time the ExtGState was activated.
*
+ * @return the transformation matrix
*/
public Matrix getInitialTransformationMatrix()
{
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/RenderingMode.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/RenderingMode.java?rev=1905235&r1=1905234&r2=1905235&view=diff
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/RenderingMode.java
(original)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/RenderingMode.java
Fri Nov 11 07:21:20 2022
@@ -79,6 +79,8 @@ public enum RenderingMode
/**
* Returns the integer value of this mode, as used in a PDF file.
+ *
+ * @return the integer value of this mode
*/
public int intValue()
{
@@ -86,7 +88,9 @@ public enum RenderingMode
}
/**
- * Returns true is this mode fills text.
+ * Returns true if this mode fills text.
+ *
+ * @return true if this mode fills text
*/
public boolean isFill()
{
@@ -97,7 +101,9 @@ public enum RenderingMode
}
/**
- * Returns true is this mode strokes text.
+ * Returns true if this mode strokes text.
+ *
+ * @return true if this mode strokes text
*/
public boolean isStroke()
{
@@ -108,7 +114,9 @@ public enum RenderingMode
}
/**
- * Returns true is this mode clips text.
+ * Returns true if this mode clips text.
+ *
+ * @return true if this mode clips text
*/
public boolean isClip()
{
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDActionEmbeddedGoTo.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDActionEmbeddedGoTo.java?rev=1905235&r1=1905234&r2=1905235&view=diff
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDActionEmbeddedGoTo.java
(original)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDActionEmbeddedGoTo.java
Fri Nov 11 07:21:20 2022
@@ -179,7 +179,7 @@ public class PDActionEmbeddedGoTo extend
/**
* Sets the target directory.
*
- * @param targetDirectory
+ * @param targetDirectory the target directory
*/
public void setTargetDirectory(PDTargetDirectory targetDirectory)
{
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/PDAnnotation.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/PDAnnotation.java?rev=1905235&r1=1905234&r2=1905235&view=diff
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/PDAnnotation.java
(original)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/PDAnnotation.java
Fri Nov 11 07:21:20 2022
@@ -352,6 +352,8 @@ public abstract class PDAnnotation imple
/**
* Returns the annotations appearance state, which selects the applicable
appearance stream from an appearance
* subdictionary.
+ *
+ * @return the annotations appearance state
*/
public COSName getAppearanceState()
{
@@ -392,6 +394,8 @@ public abstract class PDAnnotation imple
/**
* Returns the appearance stream for this annotation, if any. The
annotation state is taken into account, if
* present.
+ *
+ * @return the appearance stream
*/
public PDAppearanceStream getNormalAppearanceStream()
{
@@ -874,11 +878,10 @@ public abstract class PDAnnotation imple
}
/**
- * Create the appearance entry for this annotation. Not having it may
prevent display in some
- * viewers. This method is for overriding in subclasses, the default
implementation does
- * nothing.
+ * Create the appearance entry for this annotation. Not having it may
prevent display in some viewers. This method
+ * is for overriding in subclasses, the default implementation does
nothing.
*
- * @param document
+ * @param document the related document
*/
public void constructAppearances(PDDocument document)
{
