This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch 1.x
in repository https://gitbox.apache.org/repos/asf/commons-fileupload.git
The following commit(s) were added to refs/heads/1.x by this push:
new 06ececf8 Javadoc
06ececf8 is described below
commit 06ececf8eb930d1afa35563eb743ae6a4dc2d96d
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 11:22:14 2026 -0400
Javadoc
---
.../apache/commons/fileupload/FileItemHeaders.java | 4 ++--
.../commons/fileupload/FileItemHeadersSupport.java | 2 +-
.../apache/commons/fileupload/FileUploadBase.java | 6 ++---
.../commons/fileupload/FileUploadException.java | 2 +-
.../apache/commons/fileupload/ParameterParser.java | 28 +++++++++++-----------
.../commons/fileupload/disk/DiskFileItem.java | 2 +-
.../fileupload/disk/DiskFileItemFactory.java | 2 +-
.../fileupload/util/mime/ParseException.java | 2 +-
.../util/mime/QuotedPrintableDecoder.java | 2 +-
.../commons/fileupload/MockHttpServletRequest.java | 2 +-
10 files changed, 26 insertions(+), 26 deletions(-)
diff --git a/src/main/java/org/apache/commons/fileupload/FileItemHeaders.java
b/src/main/java/org/apache/commons/fileupload/FileItemHeaders.java
index a59ccf71..cbe6a16a 100644
--- a/src/main/java/org/apache/commons/fileupload/FileItemHeaders.java
+++ b/src/main/java/org/apache/commons/fileupload/FileItemHeaders.java
@@ -35,7 +35,7 @@ public interface FileItemHeaders {
* name, this method returns the first header in the item. The header
* name is case insensitive.
*
- * @param name a {@code String} specifying the header name
+ * @param name A {@code String} specifying the header name
* @return A {@code String} containing the value of the requested
* header, or {@code null} if the item does not have a header
* of that name
@@ -64,7 +64,7 @@ public interface FileItemHeaders {
* case insensitive.
* </p>
*
- * @param name a {@code String} specifying the header name
+ * @param name A {@code String} specifying the header name
* @return An {@code Iterator} containing the values of the
* requested header. If the item does not have any headers of
* that name, return an empty {@code Iterator}
diff --git
a/src/main/java/org/apache/commons/fileupload/FileItemHeadersSupport.java
b/src/main/java/org/apache/commons/fileupload/FileItemHeadersSupport.java
index a41673e9..2d810ab2 100644
--- a/src/main/java/org/apache/commons/fileupload/FileItemHeadersSupport.java
+++ b/src/main/java/org/apache/commons/fileupload/FileItemHeadersSupport.java
@@ -39,7 +39,7 @@ public interface FileItemHeadersSupport {
* interface to be able to get the raw headers found within the item
* header block.
*
- * @param headers the instance that holds onto the headers
+ * @param headers The instance that holds onto the headers
* for this instance.
*/
void setHeaders(FileItemHeaders headers);
diff --git a/src/main/java/org/apache/commons/fileupload/FileUploadBase.java
b/src/main/java/org/apache/commons/fileupload/FileUploadBase.java
index b594be5c..e2ef3597 100644
--- a/src/main/java/org/apache/commons/fileupload/FileUploadBase.java
+++ b/src/main/java/org/apache/commons/fileupload/FileUploadBase.java
@@ -538,7 +538,7 @@ public abstract class FileUploadBase {
* Sets the field name of the item, which caused the
* exception.
*
- * @param fieldName the field name of the item,
+ * @param fieldName The field name of the item,
* which caused the exception.
*/
public void setFieldName(final String fieldName) {
@@ -549,7 +549,7 @@ public abstract class FileUploadBase {
* Sets the file name of the item, which caused the
* exception.
*
- * @param fileName the file name of the item, which caused the
exception.
+ * @param fileName The file name of the item, which caused the
exception.
*/
public void setFileName(final String fileName) {
this.fileName = fileName;
@@ -613,7 +613,7 @@ public abstract class FileUploadBase {
* the specified detail message and cause.
*
* @param message The detail message.
- * @param cause the original cause
+ * @param cause The original cause
* @since 1.3.1
*/
public InvalidContentTypeException(final String message, final
Throwable cause) {
diff --git
a/src/main/java/org/apache/commons/fileupload/FileUploadException.java
b/src/main/java/org/apache/commons/fileupload/FileUploadException.java
index ee39cfbd..52ccc417 100644
--- a/src/main/java/org/apache/commons/fileupload/FileUploadException.java
+++ b/src/main/java/org/apache/commons/fileupload/FileUploadException.java
@@ -38,7 +38,7 @@ public class FileUploadException extends Exception {
* Constructs a new {@code FileUploadException} with specified detail
* message.
*
- * @param message the error message.
+ * @param message The error message.
*/
public FileUploadException(final String message) {
super(message);
diff --git a/src/main/java/org/apache/commons/fileupload/ParameterParser.java
b/src/main/java/org/apache/commons/fileupload/ParameterParser.java
index 4df91cb5..496021d3 100644
--- a/src/main/java/org/apache/commons/fileupload/ParameterParser.java
+++ b/src/main/java/org/apache/commons/fileupload/ParameterParser.java
@@ -130,8 +130,8 @@ public class ParameterParser {
/**
* Tests if the given character is present in the array of characters.
*
- * @param ch the character to test for presence in the array of characters
- * @param charray the array of characters to test against
+ * @param ch The character to test for presence in the array of characters
+ * @param charray The array of characters to test against
* @return {@code true} if the character is present in the array of
* characters, {@code false} otherwise.
*/
@@ -150,9 +150,9 @@ public class ParameterParser {
* Extracts a map of name/value pairs from the given array of
* characters. Names are expected to be unique.
*
- * @param charArray the array of characters that contains a sequence of
+ * @param charArray The array of characters that contains a sequence of
* name/value pairs
- * @param separator the name/value pairs separator
+ * @param separator The name/value pairs separator
* @return A map of name/value pairs
*/
public Map<String, String> parse(final char[] charArray, final char
separator) {
@@ -165,10 +165,10 @@ public class ParameterParser {
/**
* Extracts a map of name/value pairs from the given array of characters.
Names are expected to be unique.
*
- * @param charArray the array of characters that contains a sequence of
name/value pairs
- * @param offset the initial offset.
- * @param length the length.
- * @param separator the name/value pairs separator
+ * @param charArray The array of characters that contains a sequence of
name/value pairs
+ * @param offset The initial offset.
+ * @param length The length.
+ * @param separator The name/value pairs separator
* @return A map of name/value pairs
*/
public Map<String, String> parse(final char[] charArray, final int offset,
final int length, final char separator) {
@@ -214,8 +214,8 @@ public class ParameterParser {
* Extracts a map of name/value pairs from the given string. Names are
* expected to be unique.
*
- * @param str the string that contains a sequence of name/value pairs
- * @param separator the name/value pairs separator
+ * @param str The string that contains a sequence of name/value pairs
+ * @param separator The name/value pairs separator
* @return A map of name/value pairs
*/
public Map<String, String> parse(final String str, final char separator) {
@@ -230,8 +230,8 @@ public class ParameterParser {
* expected to be unique. Multiple separators may be specified and
* the earliest found in the input string is used.
*
- * @param str the string that contains a sequence of name/value pairs
- * @param separators the name/value pairs separators
+ * @param str The string that contains a sequence of name/value pairs
+ * @param separators The name/value pairs separators
* @return A map of name/value pairs
*/
public Map<String, String> parse(final String str, final char[]
separators) {
@@ -256,7 +256,7 @@ public class ParameterParser {
* Parses out a token until any of the given terminators
* is encountered outside the quotation marks.
*
- * @param terminators the array of terminating characters. Any of these
+ * @param terminators The array of terminating characters. Any of these
* characters when encountered outside the quotation marks signify the end
* of the token
*
@@ -288,7 +288,7 @@ public class ParameterParser {
* Parses out a token until any of the given terminators
* is encountered.
*
- * @param terminators the array of terminating characters. Any of these
+ * @param terminators The array of terminating characters. Any of these
* characters when encountered signify the end of the token
*
* @return The token
diff --git a/src/main/java/org/apache/commons/fileupload/disk/DiskFileItem.java
b/src/main/java/org/apache/commons/fileupload/disk/DiskFileItem.java
index 5e29e237..131a5210 100644
--- a/src/main/java/org/apache/commons/fileupload/disk/DiskFileItem.java
+++ b/src/main/java/org/apache/commons/fileupload/disk/DiskFileItem.java
@@ -466,7 +466,7 @@ public class DiskFileItem implements FileItem {
/**
* Sets the default charset for use when no explicit charset parameter is
provided by the sender.
*
- * @param charset the default charset
+ * @param charset The default charset
*/
public void setDefaultCharset(final String charset) {
defaultCharset = charset;
diff --git
a/src/main/java/org/apache/commons/fileupload/disk/DiskFileItemFactory.java
b/src/main/java/org/apache/commons/fileupload/disk/DiskFileItemFactory.java
index 84e2595d..b513db53 100644
--- a/src/main/java/org/apache/commons/fileupload/disk/DiskFileItemFactory.java
+++ b/src/main/java/org/apache/commons/fileupload/disk/DiskFileItemFactory.java
@@ -178,7 +178,7 @@ public class DiskFileItemFactory implements FileItemFactory
{
/**
* Sets the default charset for use when no explicit charset parameter is
provided by the sender.
*
- * @param charset the default charset.
+ * @param charset The default charset.
*/
public void setDefaultCharset(final String charset) {
this.defaultCharset = charset;
diff --git
a/src/main/java/org/apache/commons/fileupload/util/mime/ParseException.java
b/src/main/java/org/apache/commons/fileupload/util/mime/ParseException.java
index 3859350f..a1fbe32d 100644
--- a/src/main/java/org/apache/commons/fileupload/util/mime/ParseException.java
+++ b/src/main/java/org/apache/commons/fileupload/util/mime/ParseException.java
@@ -31,7 +31,7 @@ final class ParseException extends Exception {
/**
* Constructs a new exception with the specified detail message.
*
- * @param message the detail message.
+ * @param message The detail message.
*/
ParseException(final String message) {
super(message);
diff --git
a/src/main/java/org/apache/commons/fileupload/util/mime/QuotedPrintableDecoder.java
b/src/main/java/org/apache/commons/fileupload/util/mime/QuotedPrintableDecoder.java
index 7019f18d..176e85c6 100644
---
a/src/main/java/org/apache/commons/fileupload/util/mime/QuotedPrintableDecoder.java
+++
b/src/main/java/org/apache/commons/fileupload/util/mime/QuotedPrintableDecoder.java
@@ -113,7 +113,7 @@ final class QuotedPrintableDecoder {
/**
* Convert a hex digit to the binary value it represents.
*
- * @param b the ASCII hex byte to convert (0-0, A-F, a-f)
+ * @param b The ASCII hex byte to convert (0-0, A-F, a-f)
* @return The int value of the hex byte, 0-15
* @throws IOException if the byte is not a valid hex digit.
*/
diff --git
a/src/test/java/org/apache/commons/fileupload/MockHttpServletRequest.java
b/src/test/java/org/apache/commons/fileupload/MockHttpServletRequest.java
index cec3c2be..06459743 100644
--- a/src/test/java/org/apache/commons/fileupload/MockHttpServletRequest.java
+++ b/src/test/java/org/apache/commons/fileupload/MockHttpServletRequest.java
@@ -556,7 +556,7 @@ public class MockHttpServletRequest implements
HttpServletRequest {
/**
* Sets the read limit. This can be used to limit the number of bytes to
read ahead.
*
- * @param readLimit the read limit to use
+ * @param readLimit The read limit to use
*/
public void setReadLimit(final int readLimit) {
this.readLimit = readLimit;
