Skip to content

Commit 8810959

Browse files
committed
Javadoc
Use HTML 'em' tag instead of 'i' tag
1 parent 8d08a0f commit 8810959

22 files changed

Lines changed: 57 additions & 57 deletions

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@
157157
* What {@link DirectoryWalker} does provide for cancellation is:
158158
* </p>
159159
* <ul>
160-
* <li>{@link CancelException} which can be thrown in any of the <i>lifecycle</i> methods to stop processing.</li>
160+
* <li>{@link CancelException} which can be thrown in any of the <em>lifecycle</em> methods to stop processing.</li>
161161
* <li>The {@code walk()} method traps thrown {@link CancelException} and calls the {@code handleCancelled()}
162162
* method, providing a place for custom cancel processing.</li>
163163
* </ul>
@@ -216,7 +216,7 @@
216216
*
217217
* <p>
218218
* This shows an example of how internal cancellation processing could be implemented. <b>Note</b> the decision logic
219-
* and throwing a {@link CancelException} could be implemented in any of the <i>lifecycle</i> methods.
219+
* and throwing a {@link CancelException} could be implemented in any of the <em>lifecycle</em> methods.
220220
* </p>
221221
*
222222
* <pre>
@@ -323,14 +323,14 @@ public File getFile() {
323323
private final int depthLimit;
324324

325325
/**
326-
* Constructs an instance with no filtering and unlimited <i>depth</i>.
326+
* Constructs an instance with no filtering and unlimited <em>depth</em>.
327327
*/
328328
protected DirectoryWalker() {
329329
this(null, -1);
330330
}
331331

332332
/**
333-
* Constructs an instance with a filter and limit the <i>depth</i> navigated to.
333+
* Constructs an instance with a filter and limit the <em>depth</em> navigated to.
334334
* <p>
335335
* The filter controls which files and directories will be navigated to as
336336
* part of the walk. The {@link FileFilterUtils} class is useful for combining
@@ -339,7 +339,7 @@ protected DirectoryWalker() {
339339
* </p>
340340
*
341341
* @param filter the filter to apply, null means visit all files
342-
* @param depthLimit controls how <i>deep</i> the hierarchy is
342+
* @param depthLimit controls how <em>deep</em> the hierarchy is
343343
* navigated to (less than 0 means unlimited)
344344
*/
345345
protected DirectoryWalker(final FileFilter filter, final int depthLimit) {
@@ -349,7 +349,7 @@ protected DirectoryWalker(final FileFilter filter, final int depthLimit) {
349349

350350
/**
351351
* Constructs an instance with a directory and a file filter and an optional
352-
* limit on the <i>depth</i> navigated to.
352+
* limit on the <em>depth</em> navigated to.
353353
* <p>
354354
* The filters control which files and directories will be navigated to as part
355355
* of the walk. This constructor uses {@link FileFilterUtils#makeDirectoryOnly(IOFileFilter)}
@@ -359,7 +359,7 @@ protected DirectoryWalker(final FileFilter filter, final int depthLimit) {
359359
*
360360
* @param directoryFilter the filter to apply to directories, null means visit all directories
361361
* @param fileFilter the filter to apply to files, null means visit all files
362-
* @param depthLimit controls how <i>deep</i> the hierarchy is
362+
* @param depthLimit controls how <em>deep</em> the hierarchy is
363363
* navigated to (less than 0 means unlimited)
364364
*/
365365
protected DirectoryWalker(IOFileFilter directoryFilter, IOFileFilter fileFilter, final int depthLimit) {

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -204,15 +204,15 @@ private static String getSystemProperty(final String property) {
204204
* object at an index no smaller than {@code start}, then
205205
* the index of the first such occurrence is returned. For values
206206
* of {@code searchChar} in the range from 0 to 0xFFFF (inclusive),
207-
* this is the smallest value <i>k</i> such that:
207+
* this is the smallest value <em>k</em> such that:
208208
* </p>
209209
* <blockquote><pre>
210-
* (this.charAt(<i>k</i>) == searchChar) &amp;&amp; (<i>k</i> &gt;= start)
210+
* (this.charAt(<em>k</em>) == searchChar) &amp;&amp; (<em>k</em> &gt;= start)
211211
* </pre></blockquote>
212212
* is true. For other values of {@code searchChar}, it is the
213-
* smallest value <i>k</i> such that:
213+
* smallest value <em>k</em> such that:
214214
* <blockquote><pre>
215-
* (this.codePointAt(<i>k</i>) == searchChar) &amp;&amp; (<i>k</i> &gt;= start)
215+
* (this.codePointAt(<em>k</em>) == searchChar) &amp;&amp; (<em>k</em> &gt;= start)
216216
* </pre></blockquote>
217217
* <p>
218218
* is true. In either case, if no such character occurs in {@code cs}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1567,7 +1567,7 @@ public static boolean isDirectory(final File file, final LinkOption... options)
15671567
* @return whether the directory is empty.
15681568
* @throws IOException if an I/O error occurs.
15691569
* @throws NotDirectoryException if the file could not otherwise be opened because it is not a directory
1570-
* <i>(optional specific exception)</i>.
1570+
* <em>(optional specific exception)</em>.
15711571
* @since 2.9.0
15721572
*/
15731573
public static boolean isEmptyDirectory(final File directory) throws IOException {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
* Monitors a thread, interrupting it if it reaches the specified timeout.
2323
* <p>
2424
* This works by sleeping until the specified timeout amount and then interrupting the thread being monitored. If the
25-
* thread being monitored completes its work before being interrupted, it should {@code interrupt()} the <i>monitor</i>
25+
* thread being monitored completes its work before being interrupted, it should {@code interrupt()} the <em>monitor</em>
2626
* thread.
2727
* </p>
2828
*

src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
* ((AbstractFileComparator) DefaultFileComparator.DEFAULT_COMPARATOR).sort(list);
3636
* </pre>
3737
* <p>
38-
* Example of doing a <i>reverse</i> sort of an array of files using the
38+
* Example of doing a <em>reverse</em> sort of an array of files using the
3939
* {@link #DEFAULT_REVERSE} singleton instance:
4040
* </p>
4141
* <pre>

src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
* ((AbstractFileComparator) DirectoryFileComparator.DIRECTORY_COMPARATOR).sort(list);
3535
* </pre>
3636
* <p>
37-
* Example of doing a <i>reverse</i> sort of an array of files/directories using the {@link #DIRECTORY_REVERSE}
37+
* Example of doing a <em>reverse</em> sort of an array of files/directories using the {@link #DIRECTORY_REVERSE}
3838
* singleton instance:
3939
* </p>
4040
*

src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@
3434
* and the reverse of those options.
3535
* </p>
3636
* <p>
37-
* Example of a <i>case-sensitive</i> file extension sort using the
37+
* Example of a <em>case-sensitive</em> file extension sort using the
3838
* {@link #EXTENSION_COMPARATOR} singleton instance:
3939
* </p>
4040
* <pre>
4141
* List&lt;File&gt; list = ...
4242
* ((AbstractFileComparator) ExtensionFileComparator.EXTENSION_COMPARATOR).sort(list);
4343
* </pre>
4444
* <p>
45-
* Example of a <i>reverse case-insensitive</i> file extension sort using the
45+
* Example of a <em>reverse case-insensitive</em> file extension sort using the
4646
* {@link #EXTENSION_INSENSITIVE_REVERSE} singleton instance:
4747
* </p>
4848
* <pre>

src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
* ((AbstractFileComparator) LastModifiedFileComparator.LASTMODIFIED_COMPARATOR).sort(list);
3939
* </pre>
4040
* <p>
41-
* Example of doing a <i>reverse</i> sort of an array of files using the
41+
* Example of doing a <em>reverse</em> sort of an array of files using the
4242
* {@link #LASTMODIFIED_REVERSE} singleton instance:
4343
* </p>
4444
* <pre>

src/main/java/org/apache/commons/io/comparator/NameFileComparator.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@
3232
* and the reverse of those options.
3333
* </p>
3434
* <p>
35-
* Example of a <i>case-sensitive</i> file name sort using the
35+
* Example of a <em>case-sensitive</em> file name sort using the
3636
* {@link #NAME_COMPARATOR} singleton instance:
3737
* </p>
3838
* <pre>
3939
* List&lt;File&gt; list = ...
4040
* ((AbstractFileComparator) NameFileComparator.NAME_COMPARATOR).sort(list);
4141
* </pre>
4242
* <p>
43-
* Example of a <i>reverse case-insensitive</i> file name sort using the
43+
* Example of a <em>reverse case-insensitive</em> file name sort using the
4444
* {@link #NAME_INSENSITIVE_REVERSE} singleton instance:
4545
* </p>
4646
* <pre>

src/main/java/org/apache/commons/io/comparator/PathFileComparator.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@
3232
* and the reverse of those options.
3333
* </p>
3434
* <p>
35-
* Example of a <i>case-sensitive</i> file path sort using the
35+
* Example of a <em>case-sensitive</em> file path sort using the
3636
* {@link #PATH_COMPARATOR} singleton instance:
3737
* </p>
3838
* <pre>
3939
* List&lt;File&gt; list = ...
4040
* ((AbstractFileComparator) PathFileComparator.PATH_COMPARATOR).sort(list);
4141
* </pre>
4242
* <p>
43-
* Example of a <i>reverse case-insensitive</i> file path sort using the
43+
* Example of a <em>reverse case-insensitive</em> file path sort using the
4444
* {@link #PATH_INSENSITIVE_REVERSE} singleton instance:
4545
* </p>
4646
* <pre>

0 commit comments

Comments
 (0)