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/13 21:17:32 UTC
svn commit: r1905281 - in /pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox: pdmodel/interactive/form/PDAcroForm.java util/Hex.java util/Matrix.java util/SmallMap.java util/Vector.java util/Version.java
Author: lehmi
Date: Sun Nov 13 21:17:32 2022
New Revision: 1905281
URL: http://svn.apache.org/viewvc?rev=1905281&view=rev
Log:
PDFBOX-4892: fix javadoc
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Hex.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Matrix.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/SmallMap.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Vector.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Version.java
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.java?rev=1905281&r1=1905280&r2=1905281&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.java Sun Nov 13 21:17:32 2022
@@ -651,7 +651,7 @@ public final class PDAcroForm implements
/**
* Set a handler to support JavaScript actions in the form.
*
- * @return scriptingHandler a handler to support JavaScript actions in the form
+ * @return scriptingHandler the handler to support JavaScript actions in the form
*/
public ScriptingHandler getScriptingHandler()
{
@@ -661,7 +661,7 @@ public final class PDAcroForm implements
/**
* Set a handler to support JavaScript actions in the form.
*
- * @param scriptingHandler
+ * @param scriptingHandler a handler to support JavaScript actions in the form
*/
public void setScriptingHandler(ScriptingHandler scriptingHandler)
{
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Hex.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Hex.java?rev=1905281&r1=1905280&r2=1905281&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Hex.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Hex.java Sun Nov 13 21:17:32 2022
@@ -46,6 +46,9 @@ public final class Hex
/**
* Returns a hex string of the given byte.
+ *
+ * @param b the byte to be converted
+ * @return the hex string representing the given byte
*/
public static String getString(byte b)
{
@@ -55,6 +58,9 @@ public final class Hex
/**
* Returns a hex string of the given byte array.
+ *
+ * @param bytes the bytes to be converted
+ * @return the hex string representing the given bytes
*/
public static String getString(byte[] bytes)
{
@@ -68,6 +74,9 @@ public final class Hex
/**
* Returns the bytes corresponding to the ASCII hex encoding of the given byte.
+ *
+ * @param b the byte to be converted
+ * @return the ASCII hex encoding of the given byte
*/
public static byte[] getBytes(byte b)
{
@@ -76,6 +85,9 @@ public final class Hex
/**
* Returns the bytes corresponding to the ASCII hex encoding of the given bytes.
+ *
+ * @param bytes the bytey to be converted
+ * @return the ASCII hex encoding of the given bytes
*/
public static byte[] getBytes(byte[] bytes)
{
@@ -88,8 +100,11 @@ public final class Hex
return asciiBytes;
}
- /**
+ /**
* Returns the characters corresponding to the ASCII hex encoding of the given short.
+ *
+ * @param num the short value to be converted
+ * @return the ASCII hex encoding of the given short value
*/
public static char[] getChars(short num)
{
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Matrix.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Matrix.java?rev=1905281&r1=1905280&r2=1905281&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Matrix.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Matrix.java Sun Nov 13 21:17:32 2022
@@ -428,6 +428,8 @@ public final class Matrix implements Clo
*
* @param a The matrix to copy.
* @param b The matrix to concatenate.
+ *
+ * @return a copy of the first matrix with the second matrix concatenated
*/
public static Matrix concatenate(Matrix a, Matrix b)
{
@@ -494,7 +496,9 @@ public final class Matrix implements Clo
/**
* Returns the x-scaling element of this matrix.
*
- * @see #getScalingFactorX()
+ * @see #getScalingFactorX()
+ *
+ * @return the x-scaling element of the matrix
*/
public float getScaleX()
{
@@ -503,6 +507,8 @@ public final class Matrix implements Clo
/**
* Returns the y-shear element of this matrix.
+ *
+ * @return the y-shear element of the matrix
*/
public float getShearY()
{
@@ -511,6 +517,8 @@ public final class Matrix implements Clo
/**
* Returns the x-shear element of this matrix.
+ *
+ * @return the x-sheard element of the matrix
*/
public float getShearX()
{
@@ -521,6 +529,8 @@ public final class Matrix implements Clo
* Returns the y-scaling element of this matrix.
*
* @see #getScalingFactorY()
+ *
+ * @return the y-scaling element of the matrix
*/
public float getScaleY()
{
@@ -529,6 +539,8 @@ public final class Matrix implements Clo
/**
* Returns the x-translation element of this matrix.
+ *
+ * @return the x-translation element of the matrix
*/
public float getTranslateX()
{
@@ -537,6 +549,8 @@ public final class Matrix implements Clo
/**
* Returns the y-translation element of this matrix.
+ *
+ * @return the y-translation element of the matrix
*/
public float getTranslateY()
{
@@ -544,10 +558,10 @@ public final class Matrix implements Clo
}
/**
- * Returns a COS array which represent the geometric relevant
- * components of the matrix. The last column of the matrix is ignored,
- * only the first two columns are returned. This is analog to the
- * Matrix(COSArray) constructor.
+ * Returns a COS array which represent the geometric relevant components of the matrix. The last column of the
+ * matrix is ignored, only the first two columns are returned. This is analog to the Matrix(COSArray) constructor.
+ *
+ * @return a COSArray representing the geometric relevant components of the matrix
*/
public COSArray toCOSArray()
{
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/SmallMap.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/SmallMap.java?rev=1905281&r1=1905280&r2=1905281&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/SmallMap.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/SmallMap.java Sun Nov 13 21:17:32 2022
@@ -45,7 +45,11 @@ public class SmallMap<K, V> implements M
{
}
- /** Creates map filled with entries from provided map. */
+ /**
+ * Creates map filled with entries from provided map.
+ *
+ * @param initMap the map whose mappings are to be placed in this map
+ */
public SmallMap(Map<? extends K, ? extends V> initMap)
{
putAll(initMap);
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Vector.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Vector.java?rev=1905281&r1=1905280&r2=1905281&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Vector.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Vector.java Sun Nov 13 21:17:32 2022
@@ -33,6 +33,8 @@ public final class Vector
/**
* Returns the x magnitude.
+ *
+ * @return the x magnitude
*/
public float getX()
{
@@ -41,6 +43,8 @@ public final class Vector
/**
* Returns the y magnitude.
+ *
+ * @return the y magnitude
*/
public float getY()
{
@@ -51,6 +55,7 @@ public final class Vector
* Returns a new vector scaled by both x and y.
*
* @param sxy x and y scale
+ * @return a new vector scaled by both x and y
*/
public Vector scale(float sxy)
{
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Version.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Version.java?rev=1905281&r1=1905280&r2=1905281&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Version.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Version.java Sun Nov 13 21:17:32 2022
@@ -42,6 +42,8 @@ public final class Version
/**
* Returns the version of PDFBox.
+ *
+ * @return the version of PDFBox
*/
public static String getVersion()
{