Skip to content

Commit 82250a8

Browse files
garydgregorygarydgregory
committed
Prepare for release candidate
1 parent 7686e90 commit 82250a8

3 files changed

Lines changed: 114 additions & 98 deletions

File tree

‎src/main/java/org/apache/commons/io/charset/package-info.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
/**
1919
* Provides classes to work with code from {@link java.nio.charset}.
20+
*
2021
* @since 2.12.0
2122
*/
2223
package org.apache.commons.io.charset;

‎src/main/java/org/apache/commons/io/comparator/package-info.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
/**
1919
* Provides various {@link java.util.Comparator} implementations
20-
* for {@link java.io.File}s.
20+
* for {@link java.io.File}s and {@link java.nio.file.Path}.
2121
* <h2>Sorting</h2>
2222
* <p>
2323
* All the comparators include <i>convenience</i> utility <code>sort(File...)</code> and

‎src/site/xdoc/index.xml‎

Lines changed: 112 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -16,92 +16,103 @@ See the License for the specific language governing permissions and
1616
limitations under the License.
1717
-->
1818
<document>
19-
<properties>
20-
<title>Commons IO Overview</title>
21-
<author email="dev@commons.apache.org">Commons Documentation Team</author>
22-
</properties>
23-
<body>
24-
<!-- ================================================== -->
25-
<section name="Apache Commons IO">
26-
<p>
27-
Apache Commons IO is a library of utilities to assist with developing IO functionality.
28-
</p>
29-
<p>
30-
There are six main areas included:
31-
</p>
32-
<ul>
33-
<li>
34-
<a
35-
href="apidocs/index.html?org/apache/commons/io/package-summary.html">io</a>
36-
- This package defines utility classes for working with streams, readers, writers and files.
37-
</li>
38-
<li>
39-
<a
40-
href="apidocs/index.html?org/apache/commons/io/comparator/package-summary.html">comparator</a>
41-
- This package provides various Comparator implementations for Files.
42-
</li>
43-
<li>
44-
<a
45-
href="apidocs/index.html?org/apache/commons/io/file/package-summary.html">file</a>
46-
- This package provides extensions in the realm of java.nio.file.
47-
</li>
48-
<li>
49-
<a
50-
href="apidocs/index.html?org/apache/commons/io/filefilter/package-summary.html">filefilter</a>
51-
- This package defines an interface (IOFileFilter) that combines both FileFilter and FilenameFilter.
52-
</li>
53-
<li>
54-
<a
55-
href="apidocs/index.html?org/apache/commons/io/function/package-summary.html">function</a>
56-
- This package defines IO-only related functional interfaces for lambda expressions and method references.
57-
</li>
58-
<li>
59-
<a
60-
href="apidocs/index.html?org/apache/commons/io/input/package-summary.html">input</a>
61-
- This package provides implementations of input classes, such as InputStream and Reader.
62-
</li>
63-
<li>
64-
<a
65-
href="apidocs/index.html?org/apache/commons/io/input/buffer/package-summary.html">input.buffer</a>
66-
- This package provides implementations of buffered input classes, such as CircularBufferInputStream and PeekableInputStream.
67-
</li>
68-
<li>
69-
<a
70-
href="apidocs/index.html?org/apache/commons/io/monitor/package-summary.html">monitor</a>
71-
- This package provides a component for monitoring file system events (directory and file create, update and delete events).
72-
</li>
73-
<li>
74-
<a
75-
href="apidocs/index.html?org/apache/commons/io/output/package-summary.html">output</a>
76-
- This package provides implementations of output classes, such as OutputStream and Writer.
77-
</li>
78-
<li>
79-
<a
80-
href="apidocs/index.html?org/apache/commons/io/serialization/package-summary.html">serialization</a>
81-
- This package provides a framework for controlling the deserialization of classes.
82-
</li>
83-
</ul>
84-
</section>
85-
<!-- ================================================== -->
86-
<section name="Releases">
19+
<properties>
20+
<title>Commons IO Overview</title>
21+
<author email="dev@commons.apache.org">Commons Documentation Team</author>
22+
</properties>
23+
<body>
24+
<!-- ================================================== -->
25+
<section name="Apache Commons IO">
26+
<p>
27+
Apache Commons IO is a library of utilities to assist with developing IO functionality.
28+
</p>
29+
<p>
30+
There are six main areas included:
31+
</p>
32+
<ul>
33+
<li>
34+
<a href="apidocs/index.html?org/apache/commons/io/package-summary.html">io</a>
35+
- This package defines utility classes for working with streams, readers, writers and files.
36+
</li>
37+
<li>
38+
<a href="apidocs/index.html?org/apache/commons/io/build/package-summary.html">build</a>
39+
- This package provides classes to implement IO builders.
40+
</li>
41+
<li>
42+
<a href="apidocs/index.html?org/apache/commons/io/charset/package-summary.html">charset</a>
43+
- This package provides classes to work with code from <code>java.nio.charset</code>.
44+
</li>
45+
<li>
46+
<a href="apidocs/index.html?org/apache/commons/io/comparator/package-summary.html">comparator</a>
47+
- This package provides various Comparator implementations for Files and Paths.
48+
</li>
49+
<li>
50+
<a href="apidocs/index.html?org/apache/commons/io/file/package-summary.html">file</a>
51+
- This package provides extensions in the realm of java.nio.file.
52+
</li>
53+
<li>
54+
<a href="apidocs/index.html?org/apache/commons/io/file/attribute/package-summary.html">file.attribute</a>
55+
- This package provides help using <code>java.nio.file.attribute</code> types.
56+
</li>
57+
<li>
58+
<a href="apidocs/index.html?org/apache/commons/io/file/spi/package-summary.html">file SPI</a>
59+
- This package provides extensions in the realm of <code>java.nio.file.spi</code>.
60+
</li>
61+
<li>
62+
<a href="apidocs/index.html?org/apache/commons/io/filefilter/package-summary.html">filefilter</a>
63+
- This package defines an interface (IOFileFilter) that combines both FileFilter and FilenameFilter.
64+
</li>
65+
<li>
66+
<a href="apidocs/index.html?org/apache/commons/io/function/package-summary.html">function</a>
67+
- This package defines IO-only related functional interfaces for lambda expressions and method references.
68+
</li>
69+
<li>
70+
<a href="apidocs/index.html?org/apache/commons/io/input/package-summary.html">input</a>
71+
- This package provides implementations of input classes, such as InputStream and Reader.
72+
</li>
73+
<li>
74+
<a href="apidocs/index.html?org/apache/commons/io/input/buffer/package-summary.html">input.buffer</a>
75+
- This package provides implementations of buffered input classes, such as CircularBufferInputStream and PeekableInputStream.
76+
</li>
77+
<li>
78+
<a href="apidocs/index.html?org/apache/commons/io/monitor/package-summary.html">monitor</a>
79+
- This package provides a component for monitoring file system events (directory and file create, update and delete events).
80+
</li>
81+
<li>
82+
<a href="apidocs/index.html?org/apache/commons/io/output/package-summary.html">output</a>
83+
- This package provides implementations of output classes, such as OutputStream and Writer.
84+
</li>
85+
<li>
86+
<a href="apidocs/index.html?org/apache/commons/io/serialization/package-summary.html">serialization</a>
87+
- This package provides a framework for controlling the deserialization of classes.
88+
</li>
89+
</ul>
90+
</section>
91+
<!-- ================================================== -->
92+
<section name="Releases">
8793

88-
<subsection name="Latest Release (Java 8 and up)">
94+
<subsection name="Latest Release (Java 8 and up)">
8995
<p>
90-
Commons IO 2.13.0 requires a minimum of Java 8 -
91-
<a href="https://commons.apache.org/io/download_io.cgi">Download now</a>.
96+
Commons IO 2.13.0 requires a minimum of Java 8 -
97+
<a href="https://commons.apache.org/io/download_io.cgi">Download now</a>
98+
.
9299
</p>
93100
<p>
94-
View the
95-
<a href="changes-report.html">Release Notes</a>
96-
and
97-
<a href="apidocs/index.html">Javadoc API documents</a>.
101+
View the
102+
<a href="changes-report.html">Release Notes</a>
103+
and
104+
<a href="apidocs/index.html">Javadoc API documents</a>
105+
.
98106
</p>
99-
</subsection>
107+
</subsection>
100108

101-
<subsection name="Previous Releases">
109+
<subsection name="Previous Releases">
102110
<p>
103-
See the <a href="https://archive.apache.org/dist/commons/io/">download archive</a>
104-
and <a href="https://javadoc.io/doc/commons-io/commons-io/">Javadoc archive</a>.
111+
See the
112+
<a href="https://archive.apache.org/dist/commons/io/">download archive</a>
113+
and
114+
<a href="https://javadoc.io/doc/commons-io/commons-io/">Javadoc archive</a>
115+
.
105116
</p>
106117
<p>
107118
The Java platform requirements are:
@@ -121,23 +132,27 @@ There are six main areas included:
121132
<li>Version 2.3 requires Java 6.</li>
122133
<li>Version 2.2 requires Java 5.</li>
123134
</ul>
124-
</subsection>
135+
</subsection>
125136

126-
</section>
127-
<!-- ================================================== -->
128-
<section name="Support">
129-
<p>
130-
The <a href="mail-lists.html">commons mailing lists</a> act as the main support forum.
131-
The user list is suitable for most library usage queries.
132-
The dev list is intended for the development discussion.
133-
Please remember that the lists are shared between all commons components,
134-
so prefix your email by [io].
135-
</p>
136-
<p>
137-
Issues may be reported via <a href="issue-tracking.html">ASF JIRA</a>.
138-
Please read the instructions carefully to submit a useful bug report or enhancement request.
139-
</p>
140-
</section>
141-
<!-- ================================================== -->
142-
</body>
137+
</section>
138+
<!-- ================================================== -->
139+
<section name="Support">
140+
<p>
141+
The
142+
<a href="mail-lists.html">commons mailing lists</a>
143+
act as the main support forum.
144+
The user list is suitable for most library usage queries.
145+
The dev list is intended for the development discussion.
146+
Please remember that the lists are shared between all commons components,
147+
so prefix your email by [io].
148+
</p>
149+
<p>
150+
Issues may be reported via
151+
<a href="issue-tracking.html">ASF JIRA</a>
152+
.
153+
Please read the instructions carefully to submit a useful bug report or enhancement request.
154+
</p>
155+
</section>
156+
<!-- ================================================== -->
157+
</body>
143158
</document>

0 commit comments

Comments
 (0)