Skip to content

Commit bf545e4

Browse files
garydgregorygarydgregory
committed
[IO-424] Javadoc fixes, mostly to appease 1.8.0. Patch from Ville Skyttä". 3 files in the patch did not applied cleanly, so they are not in the commit.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/io/trunk@1563227 13f79535-47bb-0310-9956-ffa450edef68
1 parent fd63ffd commit bf545e4

15 files changed

Lines changed: 220 additions & 216 deletions

‎src/changes/changes.xml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ The <action> type attribute can be add,update,fix,remove.
4747
<body>
4848
<!-- The release date is the date RC is cut -->
4949
<release version="2.5" date="2014-??-??" description="New features and bug fixes.">
50+
<action issue="IO-424" dev="ggregory" type="fix" due-to="Ville Skyttä">
51+
Javadoc fixes, mostly to appease 1.8.0
52+
</action>
5053
<action issue="IO-422" dev="ggregory" type="update">
5154
Deprecate Charsets Charset constants in favor of Java 7's java.nio.charset.StandardCharsets
5255
</action>

‎src/main/java/org/apache/commons/io/Charsets.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,17 @@
3434
* </p>
3535
*
3636
* <ul>
37-
* <li><code>US-ASCII</code><br/>
37+
* <li><code>US-ASCII</code><br>
3838
* Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.</li>
39-
* <li><code>ISO-8859-1</code><br/>
39+
* <li><code>ISO-8859-1</code><br>
4040
* ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</li>
41-
* <li><code>UTF-8</code><br/>
41+
* <li><code>UTF-8</code><br>
4242
* Eight-bit Unicode Transformation Format.</li>
43-
* <li><code>UTF-16BE</code><br/>
43+
* <li><code>UTF-16BE</code><br>
4444
* Sixteen-bit Unicode Transformation Format, big-endian byte order.</li>
45-
* <li><code>UTF-16LE</code><br/>
45+
* <li><code>UTF-16LE</code><br>
4646
* Sixteen-bit Unicode Transformation Format, little-endian byte order.</li>
47-
* <li><code>UTF-16</code><br/>
47+
* <li><code>UTF-16</code><br>
4848
* Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order
4949
* accepted on input, big-endian used on output.)</li>
5050
* </ul>
@@ -109,7 +109,7 @@ public static Charset toCharset(final String charset) {
109109
}
110110

111111
/**
112-
* CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1. </p>
112+
* CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.
113113
* <p>
114114
* Every implementation of the Java platform is required to support this character encoding.
115115
* </p>

‎src/main/java/org/apache/commons/io/CopyUtils.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
* to be selected (otherwise the platform default is used). We would like to
5050
* encourage you to always specify the encoding because relying on the platform
5151
* default can lead to unexpected results.
52-
* <p
52+
* <p>
5353
* We don't provide special variants for the <code>copy</code> methods that
5454
* let you specify the buffer size because in modern VMs the impact on speed
5555
* seems to be minimal. We're using a default buffer size of 4 KB.

‎src/main/java/org/apache/commons/io/FileDeleteStrategy.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ static class ForceFileDeleteStrategy extends FileDeleteStrategy {
139139
/**
140140
* Deletes the file object.
141141
* <p>
142-
* This implementation uses <code>FileUtils.forceDelete() <code>
142+
* This implementation uses <code>FileUtils.forceDelete()</code>
143143
* if the file exists.
144144
*
145145
* @param fileToDelete the file to delete, not null

‎src/main/java/org/apache/commons/io/FileUtils.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1292,13 +1292,13 @@ public static void copyDirectory(final File srcDir, final File destDir,
12921292
* it is not guaranteed that those operations will succeed.
12931293
* If the modification operation fails, no indication is provided.
12941294
*
1295-
* <h4>Example: Copy directories only</h4>
1295+
* <h3>Example: Copy directories only</h3>
12961296
* <pre>
12971297
* // only copy the directory structure
12981298
* FileUtils.copyDirectory(srcDir, destDir, DirectoryFileFilter.DIRECTORY);
12991299
* </pre>
13001300
*
1301-
* <h4>Example: Copy directories and txt files</h4>
1301+
* <h3>Example: Copy directories and txt files</h3>
13021302
* <pre>
13031303
* // Create a filter for ".txt" files
13041304
* IOFileFilter txtSuffixFilter = FileFilterUtils.suffixFileFilter(".txt");
@@ -1342,13 +1342,13 @@ public static void copyDirectory(final File srcDir, final File destDir,
13421342
* not guaranteed that those operations will succeed.
13431343
* If the modification operation fails, no indication is provided.
13441344
*
1345-
* <h4>Example: Copy directories only</h4>
1345+
* <h3>Example: Copy directories only</h3>
13461346
* <pre>
13471347
* // only copy the directory structure
13481348
* FileUtils.copyDirectory(srcDir, destDir, DirectoryFileFilter.DIRECTORY, false);
13491349
* </pre>
13501350
*
1351-
* <h4>Example: Copy directories and txt files</h4>
1351+
* <h3>Example: Copy directories and txt files</h3>
13521352
* <pre>
13531353
* // Create a filter for ".txt" files
13541354
* IOFileFilter txtSuffixFilter = FileFilterUtils.suffixFileFilter(".txt");

0 commit comments

Comments
 (0)