Skip to content

Commit 23b4ec6

Browse files
committed
Javadoc: Use semantic tag <strong> instead of style tag <b>
1 parent 82a8ef1 commit 23b4ec6

34 files changed

+79
-78
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@
215215
* <h3 id="internal">3.2 Internal</h3>
216216
*
217217
* <p>
218-
* This shows an example of how internal cancellation processing could be implemented. <b>Note</b> the decision logic
218+
* This shows an example of how internal cancellation processing could be implemented. <strong>Note</strong> the decision logic
219219
* and throwing a {@link CancelException} could be implemented in any of the <em>lifecycle</em> methods.
220220
* </p>
221221
*

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -586,14 +586,14 @@ public static void copyDirectory(final File srcDir, final File destDir, final bo
586586
* {@link File#setLastModified(long)}. However it is not guaranteed that those operations will succeed. If the
587587
* modification operation fails, the method throws IOException.
588588
* </p>
589-
* <b>Example: Copy directories only</b>
589+
* <strong>Example: Copy directories only</strong>
590590
*
591591
* <pre>
592592
* // only copy the directory structure
593593
* FileUtils.copyDirectory(srcDir, destDir, DirectoryFileFilter.DIRECTORY);
594594
* </pre>
595595
*
596-
* <b>Example: Copy directories and txt files</b>
596+
* <strong>Example: Copy directories and txt files</strong>
597597
*
598598
* <pre>
599599
* // Create a filter for ".txt" files
@@ -637,14 +637,14 @@ public static void copyDirectory(final File srcDir, final File destDir, final Fi
637637
* not guaranteed that the operation will succeed. If the modification operation fails it falls back to
638638
* {@link File#setLastModified(long)}. If that fails, the method throws IOException.
639639
* </p>
640-
* <b>Example: Copy directories only</b>
640+
* <strong>Example: Copy directories only</strong>
641641
*
642642
* <pre>
643643
* // only copy the directory structure
644644
* FileUtils.copyDirectory(srcDir, destDir, DirectoryFileFilter.DIRECTORY, false);
645645
* </pre>
646646
*
647-
* <b>Example: Copy directories and txt files</b>
647+
* <strong>Example: Copy directories and txt files</strong>
648648
*
649649
* <pre>
650650
* // Create a filter for ".txt" files
@@ -688,14 +688,14 @@ public static void copyDirectory(final File srcDir, final File destDir, final Fi
688688
* not guaranteed that the operation will succeed. If the modification operation fails it falls back to
689689
* {@link File#setLastModified(long)}. If that fails, the method throws IOException.
690690
* </p>
691-
* <b>Example: Copy directories only</b>
691+
* <strong>Example: Copy directories only</strong>
692692
*
693693
* <pre>
694694
* // only copy the directory structure
695695
* FileUtils.copyDirectory(srcDir, destDir, DirectoryFileFilter.DIRECTORY, false);
696696
* </pre>
697697
*
698-
* <b>Example: Copy directories and txt files</b>
698+
* <strong>Example: Copy directories and txt files</strong>
699699
*
700700
* <pre>
701701
* // Create a filter for ".txt" files

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
* This class aims to help avoid those problems.
3838
* </p>
3939
* <p>
40-
* <b>NOTE</b>: You may be able to avoid using this class entirely simply by
40+
* <strong>NOTE</strong>: You may be able to avoid using this class entirely simply by
4141
* using JDK {@link File File} objects and the two argument constructor
4242
* {@link File#File(java.io.File, String) File(File,String)}.
4343
* </p>
@@ -634,7 +634,7 @@ public static String getBaseName(final String fileName) {
634634
* exception of a possible {@link IllegalArgumentException} on Windows (see below).
635635
* </p>
636636
* <p>
637-
* <b>Note:</b> This method used to have a hidden problem for names like "foo.exe:bar.txt".
637+
* <strong>Note:</strong> This method used to have a hidden problem for names like "foo.exe:bar.txt".
638638
* In this case, the name wouldn't be the name of a file, but the identifier of an
639639
* alternate data stream (bar.txt) on the file foo.exe. The method used to return
640640
* ".txt" here, which would be misleading. Commons IO 2.7 and later throw
@@ -644,7 +644,7 @@ public static String getBaseName(final String fileName) {
644644
* @param fileName the file name to retrieve the extension of.
645645
* @return the extension of the file or an empty string if none exists or {@code null}
646646
* if the file name is {@code null}.
647-
* @throws IllegalArgumentException <b>Windows only:</b> the file name parameter is, in fact,
647+
* @throws IllegalArgumentException <strong>Windows only:</strong> the file name parameter is, in fact,
648648
* the identifier of an Alternate Data Stream, for example "foo.exe:bar.txt".
649649
*/
650650
public static String getExtension(final String fileName) throws IllegalArgumentException {
@@ -972,7 +972,7 @@ public static int getPrefixLength(final String fileName) {
972972
* The output will be the same irrespective of the machine that the code is running on, with the
973973
* exception of a possible {@link IllegalArgumentException} on Windows (see below).
974974
* </p>
975-
* <b>Note:</b> This method used to have a hidden problem for names like "foo.exe:bar.txt".
975+
* <strong>Note:</strong> This method used to have a hidden problem for names like "foo.exe:bar.txt".
976976
* In this case, the name wouldn't be the name of a file, but the identifier of an
977977
* alternate data stream (bar.txt) on the file foo.exe. The method used to return
978978
* ".txt" here, which would be misleading. Commons IO 2.7, and later versions, are throwing
@@ -981,7 +981,7 @@ public static int getPrefixLength(final String fileName) {
981981
* @param fileName
982982
* the file name to find the last extension separator in, null returns -1
983983
* @return the index of the last extension separator character, or -1 if there is no such character
984-
* @throws IllegalArgumentException <b>Windows only:</b> the file name parameter is, in fact,
984+
* @throws IllegalArgumentException <strong>Windows only:</strong> the file name parameter is, in fact,
985985
* the identifier of an Alternate Data Stream, for example "foo.exe:bar.txt".
986986
*/
987987
public static int indexOfExtension(final String fileName) throws IllegalArgumentException {

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@ public static void closeQuietly(final Closeable closeable) {
545545
* } catch (Exception e) {
546546
* // error handling
547547
* } finally {
548-
* <b>IOUtils.closeQuietly(closeable); // In case normal close was skipped due to Exception</b>
548+
* <strong>IOUtils.closeQuietly(closeable); // In case normal close was skipped due to Exception</strong>
549549
* }
550550
* </pre>
551551
* <p>
@@ -2743,7 +2743,7 @@ public static byte[] toByteArray(final InputStream input, final int size) throws
27432743
* Gets contents of an {@link InputStream} as a {@code byte[]}.
27442744
* Use this method instead of {@link #toByteArray(InputStream)}
27452745
* when {@link InputStream} size is known.
2746-
* <b>NOTE:</b> the method checks that the length can safely be cast to an int without truncation
2746+
* <strong>NOTE:</strong> the method checks that the length can safely be cast to an int without truncation
27472747
* before using {@link IOUtils#toByteArray(InputStream, int)} to read into the byte array.
27482748
* (Arrays can have no more than Integer.MAX_VALUE entries anyway)
27492749
*

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public final class StreamIterator<E> implements Iterator<E>, AutoCloseable {
3737
/**
3838
* Wraps and presents a stream as a closable resource that automatically closes itself when reaching the end of stream.
3939
* <p>
40-
* <b>Warning</b>
40+
* <strong>Warning</strong>
4141
* </p>
4242
* <p>
4343
* In order to close the stream, the call site MUST either close the stream it allocated OR call this iterator until the end.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
import java.util.Comparator;
2222

2323
/**
24-
* Compares two files using the <b>default</b> {@link File#compareTo(File)} method.
24+
* Compares two files using the <strong>default</strong> {@link File#compareTo(File)} method.
2525
* <p>
2626
* This comparator can be used to sort lists or arrays of files
2727
* by using the default file comparison.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
import org.apache.commons.io.IOCase;
2525

2626
/**
27-
* Compare the file name <b>extensions</b> for order
27+
* Compare the file name <strong>extensions</strong> for order
2828
* (see {@link FilenameUtils#getExtension(String)}).
2929
* <p>
3030
* This comparator can be used to sort lists or arrays of files

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import org.apache.commons.io.FileUtils;
2424

2525
/**
26-
* Compare the <b>last modified date/time</b> of two files for order
26+
* Compare the <strong>last modified date/time</strong> of two files for order
2727
* (see {@link FileUtils#lastModifiedUnchecked(File)}).
2828
* <p>
2929
* This comparator can be used to sort lists or arrays of files

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import org.apache.commons.io.IOCase;
2424

2525
/**
26-
* Compare the <b>names</b> of two files for order (see {@link File#getName()}).
26+
* Compare the <strong>names</strong> of two files for order (see {@link File#getName()}).
2727
* <p>
2828
* This comparator can be used to sort lists or arrays of files
2929
* by their name either in a case-sensitive, case-insensitive or

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import org.apache.commons.io.IOCase;
2424

2525
/**
26-
* Compare the <b>path</b> of two files for order (see {@link File#getPath()}).
26+
* Compare the <strong>path</strong> of two files for order (see {@link File#getPath()}).
2727
* <p>
2828
* This comparator can be used to sort lists or arrays of files
2929
* by their path either in a case-sensitive, case-insensitive or

0 commit comments

Comments
 (0)