Skip to content

Commit 441115a

Browse files
committed
Use Javadoc instead of HTML tag
1 parent 4341fc8 commit 441115a

File tree

4 files changed

+33
-33
lines changed

4 files changed

+33
-33
lines changed

src/main/java/org/apache/commons/io/ByteBuffers.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public static ByteBuffer littleEndian(final ByteBuffer allocate) {
6262
*
6363
* @param capacity The new buffer's capacity, in bytes.
6464
* @return The new byte buffer.
65-
* @throws IllegalArgumentException If the <code>capacity</code> is negative.
65+
* @throws IllegalArgumentException If the {@code capacity} is negative.
6666
*/
6767
public static ByteBuffer littleEndian(final int capacity) {
6868
return littleEndian(ByteBuffer.allocate(capacity));

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

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
* for {@link java.io.File}s and {@link java.nio.file.Path}.
2121
* <h2>Sorting</h2>
2222
* <p>
23-
* All the comparators include <em>convenience</em> utility <code>sort(File...)</code> and
24-
* <code>sort(List)</code> methods.
23+
* All the comparators include <em>convenience</em> utility {@code sort(File...)} and
24+
* {@code sort(List)} methods.
2525
* </p>
2626
* <p>
2727
* For example, to sort the files in a directory by name:
@@ -62,114 +62,114 @@
6262
* <li><a href="DefaultFileComparator.html">DefaultFileComparator</a> - default file compare:
6363
* <ul>
6464
* <li><a href="DefaultFileComparator.html#DEFAULT_COMPARATOR">DEFAULT_COMPARATOR</a>
65-
* - Compare using <code>File.compareTo(File)</code> method.
65+
* - Compare using {@code File.compareTo(File)} method.
6666
* </li>
6767
* <li><a href="DefaultFileComparator.html#DEFAULT_REVERSE">DEFAULT_REVERSE</a>
68-
* - Reverse compare of <code>File.compareTo(File)</code> method.
68+
* - Reverse compare of {@code File.compareTo(File)} method.
6969
* </li>
7070
* </ul>
7171
* </li>
7272
* <li><a href="DirectoryFileComparator.html">DirectoryFileComparator</a> - compare by type (directory or file):
7373
* <ul>
7474
* <li><a href="DirectoryFileComparator.html#DIRECTORY_COMPARATOR">DIRECTORY_COMPARATOR</a>
75-
* - Compare using <code>File.isDirectory()</code> method (directories &lt; files).
75+
* - Compare using {@code File.isDirectory()} method (directories &lt; files).
7676
* </li>
7777
* <li><a href="DirectoryFileComparator.html#DIRECTORY_REVERSE">DIRECTORY_REVERSE</a>
78-
* - Reverse compare of <code>File.isDirectory()</code> method (directories &gt;files).
78+
* - Reverse compare of {@code File.isDirectory()} method (directories &gt;files).
7979
* </li>
8080
* </ul>
8181
* </li>
8282
* <li><a href="ExtensionFileComparator.html">ExtensionFileComparator</a> - compare file extensions:
8383
* <ul>
8484
* <li><a href="ExtensionFileComparator.html#EXTENSION_COMPARATOR">EXTENSION_COMPARATOR</a>
85-
* - Compare using <code>FilenameUtils.getExtension(String)</code> method.
85+
* - Compare using {@code FilenameUtils.getExtension(String)} method.
8686
* </li>
8787
* <li><a href="ExtensionFileComparator.html#EXTENSION_REVERSE">EXTENSION_REVERSE</a>
88-
* - Reverse compare of <code>FilenameUtils.getExtension(String)</code> method.
88+
* - Reverse compare of {@code FilenameUtils.getExtension(String)} method.
8989
* </li>
9090
* <li><a href="ExtensionFileComparator.html#EXTENSION_INSENSITIVE_COMPARATOR">EXTENSION_INSENSITIVE_COMPARATOR</a>
91-
* - Case-insensitive compare using <code>FilenameUtils.getExtension(String)</code> method.
91+
* - Case-insensitive compare using {@code FilenameUtils.getExtension(String)} method.
9292
* </li>
9393
* <li><a href="ExtensionFileComparator.html#EXTENSION_INSENSITIVE_REVERSE">EXTENSION_INSENSITIVE_REVERSE</a>
94-
* - Reverse case-insensitive compare of <code>FilenameUtils.getExtension(String)</code> method.
94+
* - Reverse case-insensitive compare of {@code FilenameUtils.getExtension(String)} method.
9595
* </li>
9696
* <li><a href="ExtensionFileComparator.html#EXTENSION_SYSTEM_COMPARATOR">EXTENSION_SYSTEM_COMPARATOR</a>
97-
* - System sensitive compare using <code>FilenameUtils.getExtension(String)</code> method.
97+
* - System sensitive compare using {@code FilenameUtils.getExtension(String)} method.
9898
* </li>
9999
* <li><a href="ExtensionFileComparator.html#EXTENSION_SYSTEM_REVERSE">EXTENSION_SYSTEM_REVERSE</a>
100-
* - Reverse system sensitive compare of <code>FilenameUtils.getExtension(String)</code> method.
100+
* - Reverse system sensitive compare of {@code FilenameUtils.getExtension(String)} method.
101101
* </li>
102102
* </ul>
103103
* </li>
104104
* <li><a href="LastModifiedFileComparator.html">LastModifiedFileComparator</a>
105105
* - compare the file's last modified date/time:
106106
* <ul>
107107
* <li><a href="LastModifiedFileComparator.html#LASTMODIFIED_COMPARATOR">LASTMODIFIED_COMPARATOR</a>
108-
* - Compare using <code>File.lastModified()</code> method.
108+
* - Compare using {@code File.lastModified()} method.
109109
* </li>
110110
* <li><a href="LastModifiedFileComparator.html#LASTMODIFIED_REVERSE">LASTMODIFIED_REVERSE</a>
111-
* - Reverse compare of <code>File.lastModified()</code> method.
111+
* - Reverse compare of {@code File.lastModified()} method.
112112
* </li>
113113
* </ul>
114114
* </li>
115115
* <li><a href="NameFileComparator.html">NameFileComparator</a> - compare file names:
116116
* <ul>
117117
* <li><a href="NameFileComparator.html#NAME_COMPARATOR">NAME_COMPARATOR</a>
118-
* - Compare using <code>File.getName()</code> method.
118+
* - Compare using {@code File.getName()} method.
119119
* </li>
120120
* <li><a href="NameFileComparator.html#NAME_REVERSE">NAME_REVERSE</a>
121-
* - Reverse compare of <code>File.getName()</code> method.
121+
* - Reverse compare of {@code File.getName()} method.
122122
* </li>
123123
* <li><a href="NameFileComparator.html#NAME_INSENSITIVE_COMPARATOR">NAME_INSENSITIVE_COMPARATOR</a>
124-
* - Case-insensitive compare using <code>File.getName()</code> method.
124+
* - Case-insensitive compare using {@code File.getName()} method.
125125
* </li>
126126
* <li><a href="NameFileComparator.html#NAME_INSENSITIVE_REVERSE">NAME_INSENSITIVE_REVERSE</a>
127-
* - Reverse case-insensitive compare of <code>File.getName()</code> method.
127+
* - Reverse case-insensitive compare of {@code File.getName()} method.
128128
* </li>
129129
* <li><a href="NameFileComparator.html#NAME_SYSTEM_COMPARATOR">NAME_SYSTEM_COMPARATOR</a>
130-
* - System sensitive compare using <code>File.getName()</code> method.
130+
* - System sensitive compare using {@code File.getName()} method.
131131
* </li>
132132
* <li><a href="NameFileComparator.html#NAME_SYSTEM_REVERSE">NAME_SYSTEM_REVERSE</a>
133-
* - Reverse system sensitive compare of <code>File.getName()</code> method.
133+
* - Reverse system sensitive compare of {@code File.getName()} method.
134134
* </li>
135135
* </ul>
136136
* </li>
137137
* <li><a href="PathFileComparator.html">PathFileComparator</a> - compare file paths:
138138
* <ul>
139139
* <li><a href="PathFileComparator.html#PATH_COMPARATOR">PATH_COMPARATOR</a>
140-
* - Compare using <code>File.getPath()</code> method.
140+
* - Compare using {@code File.getPath()} method.
141141
* </li>
142142
* <li><a href="PathFileComparator.html#PATH_REVERSE">PATH_REVERSE</a>
143-
* - Reverse compare of <code>File.getPath()</code> method.
143+
* - Reverse compare of {@code File.getPath()} method.
144144
* </li>
145145
* <li><a href="PathFileComparator.html#PATH_INSENSITIVE_COMPARATOR">PATH_INSENSITIVE_COMPARATOR</a>
146-
* - Case-insensitive compare using <code>File.getPath()</code> method.
146+
* - Case-insensitive compare using {@code File.getPath()} method.
147147
* </li>
148148
* <li><a href="PathFileComparator.html#PATH_INSENSITIVE_REVERSE">PATH_INSENSITIVE_REVERSE</a>
149-
* - Reverse case-insensitive compare of <code>File.getPath()</code> method.
149+
* - Reverse case-insensitive compare of {@code File.getPath()} method.
150150
* </li>
151151
* <li><a href="PathFileComparator.html#PATH_SYSTEM_COMPARATOR">PATH_SYSTEM_COMPARATOR</a>
152-
* - System sensitive compare using <code>File.getPath()</code> method.
152+
* - System sensitive compare using {@code File.getPath()} method.
153153
* </li>
154154
* <li><a href="PathFileComparator.html#PATH_SYSTEM_REVERSE">PATH_SYSTEM_REVERSE</a>
155-
* - Reverse system sensitive compare of <code>File.getPath()</code> method.
155+
* - Reverse system sensitive compare of {@code File.getPath()} method.
156156
* </li>
157157
* </ul>
158158
* </li>
159159
* <li><a href="SizeFileComparator.html">SizeFileComparator</a> - compare the file's size:
160160
* <ul>
161161
* <li><a href="SizeFileComparator.html#SIZE_COMPARATOR">SIZE_COMPARATOR</a>
162-
* - Compare using <code>File.length()</code> method (directories treated as zero length).
162+
* - Compare using {@code File.length()} method (directories treated as zero length).
163163
* </li>
164164
* <li><a href="SizeFileComparator.html#SIZE_REVERSE">LASTMODIFIED_REVERSE</a>
165-
* - Reverse compare of <code>File.length()</code> method (directories treated as zero length).
165+
* - Reverse compare of {@code File.length()} method (directories treated as zero length).
166166
* </li>
167167
* <li><a href="SizeFileComparator.html#SIZE_SUMDIR_COMPARATOR">SIZE_SUMDIR_COMPARATOR</a>
168-
* - Compare using <code>FileUtils.sizeOfDirectory(File)</code> method
168+
* - Compare using {@code FileUtils.sizeOfDirectory(File)} method
169169
* (sums the size of a directory's contents).
170170
* </li>
171171
* <li><a href="SizeFileComparator.html#SIZE_SUMDIR_REVERSE">SIZE_SUMDIR_REVERSE</a>
172-
* - Reverse compare of <code>FileUtils.sizeOfDirectory(File)</code> method
172+
* - Reverse compare of {@code FileUtils.sizeOfDirectory(File)} method
173173
* (sums the size of a directory's contents).
174174
* </li>
175175
* </ul>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@
148148
* }
149149
* </pre>
150150
* <h2>Using NIO</h2>
151-
* <p>You can combine Java <strong>file tree walking</strong> by using <code>java.nio.file.Files.walk()</code> APIs with filters:</p>
151+
* <p>You can combine Java <strong>file tree walking</strong> by using {@code java.nio.file.Files.walk()} APIs with filters:</p>
152152
* <pre>
153153
* final Path dir = Paths.get("");
154154
* // We are interested in files older than one day

src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public SwappedDataInputStream(final InputStream input) {
4444
}
4545

4646
/**
47-
* Return <code>{@link #readByte()} != 0</code>
47+
* Return {@code {@link #readByte()} != 0}
4848
*
4949
* @return false if the byte read is zero, otherwise true
5050
* @throws IOException if an I/O error occurs.

0 commit comments

Comments
 (0)