You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ti...@apache.org on 2021/11/14 08:41:47 UTC
svn commit: r1895011 - in /pdfbox/trunk/pdfbox/src: main/java/org/apache/pdfbox/cos/ test/java/org/apache/pdfbox/multipdf/
Author: tilman
Date: Sun Nov 14 08:41:47 2021
New Revision: 1895011
URL: http://svn.apache.org/viewvc?rev=1895011&view=rev
Log:
PDFBOX-4892: fix javadoc, as suggested by valerybokov
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSArray.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSFloat.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSNull.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSObjectKey.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSString.java
pdfbox/trunk/pdfbox/src/test/java/org/apache/pdfbox/multipdf/PDFMergerUtilityTest.java
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSArray.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSArray.java?rev=1895011&r1=1895010&r2=1895011&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSArray.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSArray.java Sun Nov 14 08:41:47 2021
@@ -140,7 +140,7 @@ public class COSArray extends COSBase im
/**
* This will add all objects to this array.
*
- * @param objectList The objects to add.
+ * @param objectList The list of objects to add.
*/
public void addAll( COSArray objectList )
{
@@ -546,7 +546,7 @@ public class COSArray extends COSBase im
}
/**
- * visitor pattern double dispatch method.
+ * Visitor pattern double dispatch method.
*
* @param visitor The object to notify when visiting this object.
* @return any object, depending on the visitor implementation, or null
@@ -670,7 +670,7 @@ public class COSArray extends COSBase im
}
/**
- * This will take an list of integer objects and return a COSArray of COSInteger objects.
+ * This will take a list of integer objects and return a COSArray of COSInteger objects.
*
* @param integer A list of integers
*
@@ -684,7 +684,7 @@ public class COSArray extends COSBase im
}
/**
- * This will take an list of string objects and return a COSArray of COSName objects.
+ * This will take a list of string objects and return a COSArray of COSName objects.
*
* @param strings A list of strings
*
@@ -698,7 +698,7 @@ public class COSArray extends COSBase im
}
/**
- * This will take an list of string objects and return a COSArray of COSName objects.
+ * This will take a list of string objects and return a COSArray of COSName objects.
*
* @param strings A list of strings
*
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSFloat.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSFloat.java?rev=1895011&r1=1895010&r2=1895011&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSFloat.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSFloat.java Sun Nov 14 08:41:47 2021
@@ -199,7 +199,7 @@ public class COSFloat extends COSNumber
}
/**
- * Builds, if needed, and returns the a string representation of the current value.
+ * Builds, if needed, and returns the string representation of the current value.
* @return current value as string.
*/
private String formatString()
@@ -212,7 +212,7 @@ public class COSFloat extends COSNumber
}
/**
- * visitor pattern double dispatch method.
+ * Visitor pattern double dispatch method.
*
* @param visitor The object to notify when visiting this object.
* @return any object, depending on the visitor implementation, or null
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSNull.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSNull.java?rev=1895011&r1=1895010&r2=1895011&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSNull.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSNull.java Sun Nov 14 08:41:47 2021
@@ -45,7 +45,7 @@ public final class COSNull extends COSBa
}
/**
- * visitor pattern double dispatch method.
+ * Visitor pattern double dispatch method.
*
* @param visitor The object to notify when visiting this object.
* @return any object, depending on the visitor implementation, or null
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSObjectKey.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSObjectKey.java?rev=1895011&r1=1895010&r2=1895011&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSObjectKey.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSObjectKey.java Sun Nov 14 08:41:47 2021
@@ -72,9 +72,9 @@ public final class COSObjectKey implemen
}
/**
- * This will get the generation number.
+ * This will get the object generation number.
*
- * @return The objects generation number.
+ * @return The object generation number.
*/
public int getGeneration()
{
@@ -82,9 +82,9 @@ public final class COSObjectKey implemen
}
/**
- * This will get the objects id.
+ * This will get the object number.
*
- * @return The object's id.
+ * @return The object number.
*/
public long getNumber()
{
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSString.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSString.java?rev=1895011&r1=1895010&r2=1895011&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSString.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSString.java Sun Nov 14 08:41:47 2021
@@ -152,7 +152,7 @@ public final class COSString extends COS
}
/**
- * Sets whether or not to force the string is to be written in hex form.
+ * Sets whether to force the string is to be written in hex form.
* This is needed when signing PDF files.
*
* @param value True to force hex.
Modified: pdfbox/trunk/pdfbox/src/test/java/org/apache/pdfbox/multipdf/PDFMergerUtilityTest.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/test/java/org/apache/pdfbox/multipdf/PDFMergerUtilityTest.java?rev=1895011&r1=1895010&r2=1895011&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/test/java/org/apache/pdfbox/multipdf/PDFMergerUtilityTest.java (original)
+++ pdfbox/trunk/pdfbox/src/test/java/org/apache/pdfbox/multipdf/PDFMergerUtilityTest.java Sun Nov 14 08:41:47 2021
@@ -713,8 +713,7 @@ class PDFMergerUtilityTest
/**
* Check that there is a top level Document and Parts below in a merge of 2 documents.
*
- * @param file
- * @throws IOException
+ * @throws IOException
*/
@Test
void testPDFBox5198_2() throws IOException
@@ -730,9 +729,8 @@ class PDFMergerUtilityTest
/**
* Check that there is a top level Document and Parts below in a merge of 3 documents.
- *
- * @param file
- * @throws IOException
+ *
+ * @throws IOException
*/
@Test
void testPDFBox5198_3() throws IOException