This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-fileupload.git
The following commit(s) were added to refs/heads/master by this push:
new f370ec0 Javadoc
f370ec0 is described below
commit f370ec0133b14e4d71b21562a915b9f263bd22f1
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Jun 11 09:31:11 2023 -0400
Javadoc
---
.../apache/commons/fileupload2/disk/package-info.java | 18 ++++++++++--------
.../org/apache/commons/fileupload2/package-info.java | 4 ++--
.../commons/fileupload2/jakarta/package-info.java | 6 +++---
.../apache/commons/fileupload2/javax/package-info.java | 12 ++++++------
.../commons/fileupload2/portlet/package-info.java | 12 ++++++------
5 files changed, 27 insertions(+), 25 deletions(-)
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/disk/package-info.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/disk/package-info.java
index 8bfadbc..75c7a91 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/disk/package-info.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/disk/package-info.java
@@ -17,12 +17,12 @@
/**
* <p>
- * A disk-based implementation of the {@link FileItem FileItem} interface.
This implementation retains smaller items in memory,
+ * A disk-based implementation of the {@link
org.apache.commons.fileupload2.FileItem} interface. This implementation retains
smaller items in memory,
* while writing larger ones to disk. The threshold between these two is
configurable, as is the location of files that are written to disk.
* </p>
* <p>
- * In typical usage, an instance of {@link DiskFileItemFactory
DiskFileItemFactory} would be created, configured, and then
- * passed to a {@link FileUpload FileUpload} implementation such as
+ * In typical usage, an instance of {@link
org.apache.commons.fileupload2.disk.DiskFileItemFactory} would be created,
configured, and then
+ * passed to a {@link org.apache.commons.fileupload2.FileUpload}
implementation such as
* {@code org.apache.commons.fileupload2.servlet.ServletFileUpload
ServletFileUpload} or
* {@code org.apache.commons.fileupload2.portlet.PortletFileUpload
PortletFileUpload}.
* </p>
@@ -31,11 +31,13 @@
* </p>
*
* <pre>
- * DiskFileItemFactory factory = new DiskFileItemFactory();
- * // maximum size that will be stored in memory
- * factory.setSizeThreshold(4096);
- * // the location for saving data that is larger than getSizeThreshold()
- * factory.setRepository(new File("/tmp"));
+ * DiskFileItemFactory factory = DiskFileItemFactory().builder()
+ * // maximum size that will be stored in memory
+ * .setSizeThreshold(4096);
+ * // the location for saving data that is larger than getSizeThreshold()
+ * .setRepository(new File("/tmp"))
+ * // build it
+ * .get();
*
* ServletFileUpload upload = new ServletFileUpload(factory);
* </pre>
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/package-info.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/package-info.java
index 3ad42bc..79a101e 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/package-info.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/package-info.java
@@ -31,7 +31,7 @@
* The following is a brief example of typical usage in a servlet, storing the
uploaded files on disk.
* </p>
*
- * <pre>
+ * <pre>{@code
* public void doPost(HttpServletRequest req, HttpServletResponse res) {
* DiskFileItemFactory factory = new DiskFileItemFactory.builder()
* // maximum size that will be stored in memory
@@ -59,7 +59,7 @@
* // write the file
* fi.write(new File("/www/uploads/", fileName));
* }
- * </pre>
+ * }</pre>
* <p>
* In the example above, the first file is loaded into memory as a {@code
String}. Before calling the {@code getString} method, the data may have been in
memory
* or on disk depending on its size. The second file we assume it will be
large and therefore never explicitly load it into memory, though if it is less
than
diff --git
a/commons-fileupload2-jakarta/src/main/java/org/apache/commons/fileupload2/jakarta/package-info.java
b/commons-fileupload2-jakarta/src/main/java/org/apache/commons/fileupload2/jakarta/package-info.java
index 72afa84..b82309c 100644
---
a/commons-fileupload2-jakarta/src/main/java/org/apache/commons/fileupload2/jakarta/package-info.java
+++
b/commons-fileupload2-jakarta/src/main/java/org/apache/commons/fileupload2/jakarta/package-info.java
@@ -24,13 +24,13 @@
* The following code fragment demonstrates typical usage.
* </p>
*
- * <pre>
- * DiskFileItemFactory factory = new DiskFileItemFactory().builder().get();
+ * <pre>{@code
+ * DiskFileItemFactory factory = DiskFileItemFactory().builder().get();
* // Configure the factory here, if desired.
* JakSrvltFileUpload upload = new JakSrvltFileUpload(factory);
* // Configure the uploader here, if desired.
* List fileItems = upload.parseRequest(request);
- * </pre>
+ * }</pre>
* <p>
* Please see the FileUpload <a
href="https://commons.apache.org/fileupload/using.html"; target="_top">User
Guide</a> for further details and examples of how to
* use this package.
diff --git
a/commons-fileupload2-javax/src/main/java/org/apache/commons/fileupload2/javax/package-info.java
b/commons-fileupload2-javax/src/main/java/org/apache/commons/fileupload2/javax/package-info.java
index 67f7ca6..574d9a8 100644
---
a/commons-fileupload2-javax/src/main/java/org/apache/commons/fileupload2/javax/package-info.java
+++
b/commons-fileupload2-javax/src/main/java/org/apache/commons/fileupload2/javax/package-info.java
@@ -17,21 +17,21 @@
/**
* <p>
- * An implementation of {@link org.apache.commons.fileupload2.FileUpload} for
use in servlets conforming to JSR 53. This implementation requires only
- * access to the servlet's current {@code HttpServletRequest} instance, and a
suitable {@link FileItemFactory FileItemFactory}
- * implementation, such as {@link
org.apache.commons.fileupload2.disk.DiskFileItemFactory}.
+ * An implementation of {@link org.apache.commons.fileupload2.FileUpload} for
use in servlets conforming to JSR 53. This implementation requires only access
to
+ * the servlet's current {@code HttpServletRequest} instance, and a suitable
{@link FileItemFactory FileItemFactory} implementation, such as
+ * {@link org.apache.commons.fileupload2.disk.DiskFileItemFactory}.
* </p>
* <p>
* The following code fragment demonstrates typical usage.
* </p>
*
- * <pre>
- * DiskFileItemFactory factory = new DiskFileItemFactory().builder().get();
+ * <pre>{@code
+ * DiskFileItemFactory factory = DiskFileItemFactory().builder().get();
* // Configure the factory here, if desired.
* ServletFileUpload upload = new ServletFileUpload(factory);
* // Configure the uploader here, if desired.
* List fileItems = upload.parseRequest(request);
- * </pre>
+ * }</pre>
* <p>
* Please see the FileUpload <a
href="https://commons.apache.org/fileupload/using.html"; target="_top">User
Guide</a> for further details and examples of how to
* use this package.
diff --git
a/commons-fileupload2-portlet/src/main/java/org/apache/commons/fileupload2/portlet/package-info.java
b/commons-fileupload2-portlet/src/main/java/org/apache/commons/fileupload2/portlet/package-info.java
index e63ae96..0aeecd0 100644
---
a/commons-fileupload2-portlet/src/main/java/org/apache/commons/fileupload2/portlet/package-info.java
+++
b/commons-fileupload2-portlet/src/main/java/org/apache/commons/fileupload2/portlet/package-info.java
@@ -17,21 +17,21 @@
/**
* <p>
- * An implementation of {@link org.apache.commons.fileupload2.FileUpload} for
use in portlets conforming to JSR 168. This implementation requires
- * only access to the portlet's current {@code ActionRequest} instance, and a
suitable {@link org.apache.commons.fileupload2.FileItemFactory}
- * implementation, such as {@link
org.apache.commons.fileupload2.disk.DiskFileItemFactory}.
+ * An implementation of {@link org.apache.commons.fileupload2.FileUpload} for
use in portlets conforming to JSR 168. This implementation requires only access
to
+ * the portlet's current {@code ActionRequest} instance, and a suitable {@link
org.apache.commons.fileupload2.FileItemFactory} implementation, such as
+ * {@link org.apache.commons.fileupload2.disk.DiskFileItemFactory}.
* </p>
* <p>
* The following code fragment demonstrates typical usage.
* </p>
*
- * <pre>
- * DiskFileItemFactory factory = new DiskFileItemFactory();
+ * <pre>{@code
+ * DiskFileItemFactory factory = DiskFileItemFactory().builder().get();
* // Configure the factory here, if desired.
* PortletFileUpload upload = new PortletFileUpload(factory);
* // Configure the uploader here, if desired.
* List fileItems = upload.parseRequest(request);
- * </pre>
+ * }</pre>
* <p>
* Please see the FileUpload <a
href="https://commons.apache.org/fileupload/using.html"; target="_top">User
Guide</a> for further details and examples of how to
* use this package.
