Javadoc: Use semantic tag <strong> instead of style tag <b>

garydgregory · garydgregory · commit 44373279e1c3 · 2024-11-15T10:11:03.000-05:00
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java b/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
@@ -34,7 +34,7 @@
  * character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8, etc).
  * </p>
  * <p>
- * <b>Note:</b> It is mandatory to close the stream after the last byte has been written to it, otherwise the
+ * <strong>Note:</strong> It is mandatory to close the stream after the last byte has been written to it, otherwise the
  * final padding will be omitted and the resulting data will be incomplete/inconsistent.
  * </p>
  * <p>
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -193,7 +193,7 @@ public static Builder builder() {
     /**
      * Decodes Base64 data into octets.
      * <p>
-     * <b>Note:</b> this method seamlessly handles data encoded in URL-safe or normal mode.
+     * <strong>Note:</strong> this method seamlessly handles data encoded in URL-safe or normal mode.
      * </p>
      *
      * @param base64Data
@@ -207,7 +207,7 @@ public static byte[] decodeBase64(final byte[] base64Data) {
     /**
      * Decodes a Base64 String into octets.
      * <p>
-     * <b>Note:</b> this method seamlessly handles data encoded in URL-safe or normal mode.
+     * <strong>Note:</strong> this method seamlessly handles data encoded in URL-safe or normal mode.
      * </p>
      *
      * @param base64String
@@ -266,7 +266,7 @@ public static byte[] encodeBase64(final byte[] binaryData, final boolean isChunk
      *            if {@code true} this encoder will chunk the base64 output into 76 character blocks
      * @param urlSafe
      *            if {@code true} this encoder will emit - and _ instead of the usual + and / characters.
-     *            <b>Note: No padding is added when encoding using the URL-safe alphabet.</b>
+     *            <strong>Note: No padding is added when encoding using the URL-safe alphabet.</strong>
      * @return Base64-encoded data.
      * @throws IllegalArgumentException
      *             Thrown when the input array needs an output array bigger than {@link Integer#MAX_VALUE}
@@ -285,7 +285,7 @@ public static byte[] encodeBase64(final byte[] binaryData, final boolean isChunk
      *            if {@code true} this encoder will chunk the base64 output into 76 character blocks
      * @param urlSafe
      *            if {@code true} this encoder will emit - and _ instead of the usual + and / characters.
-     *            <b>Note: No padding is added when encoding using the URL-safe alphabet.</b>
+     *            <strong>Note: No padding is added when encoding using the URL-safe alphabet.</strong>
      * @param maxResultSize
      *            The maximum result size to accept.
      * @return Base64-encoded data.
@@ -340,7 +340,7 @@ public static String encodeBase64String(final byte[] binaryData) {
     /**
      * Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output. The
      * url-safe variation emits - and _ instead of + and / characters.
-     * <b>Note: No padding is added.</b>
+     * <strong>Note: No padding is added.</strong>
      * @param binaryData
      *            binary data to encode
      * @return byte[] containing Base64 characters in their UTF-8 representation.
@@ -353,7 +353,7 @@ public static byte[] encodeBase64URLSafe(final byte[] binaryData) {
     /**
      * Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output. The
      * url-safe variation emits - and _ instead of + and / characters.
-     * <b>Note: No padding is added.</b>
+     * <strong>Note: No padding is added.</strong>
      * @param binaryData
      *            binary data to encode
      * @return String containing Base64 characters
@@ -603,7 +603,7 @@ public Base64(final int lineLength, final byte[] lineSeparator) {
      * @param urlSafe
      *            Instead of emitting '+' and '/' we emit '-' and '_' respectively. urlSafe is only applied to encode
      *            operations. Decoding seamlessly handles both modes.
-     *            <b>Note: No padding is added when using the URL-safe alphabet.</b>
+     *            <strong>Note: No padding is added when using the URL-safe alphabet.</strong>
      * @throws IllegalArgumentException
      *             Thrown when the {@code lineSeparator} contains Base64 characters.
      * @since 1.4
@@ -634,7 +634,7 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
      * @param urlSafe
      *            Instead of emitting '+' and '/' we emit '-' and '_' respectively. urlSafe is only applied to encode
      *            operations. Decoding seamlessly handles both modes.
-     *            <b>Note: No padding is added when using the URL-safe alphabet.</b>
+     *            <strong>Note: No padding is added when using the URL-safe alphabet.</strong>
      * @param decodingPolicy The decoding policy.
      * @throws IllegalArgumentException
      *             Thrown when the {@code lineSeparator} contains Base64 characters.
@@ -807,7 +807,7 @@ void decode(final byte[] input, int inPos, final int inAvail, final Context cont
      * the data to encode, and once with inAvail set to "-1" to alert encoder that EOF has been reached, to flush last
      * remaining bytes (if not multiple of 3).
      * </p>
-     * <p><b>Note: No padding is added when encoding using the URL-safe alphabet.</b></p>
+     * <p><strong>Note: No padding is added when encoding using the URL-safe alphabet.</strong></p>
      * <p>
      * Thanks to "commons" project in ws.apache.org for the bitwise operations, and general approach.
      * https://svn.apache.org/repos/asf/webservices/commons/trunk/modules/util/
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java b/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
@@ -38,7 +38,7 @@
  * character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8, etc).
  * </p>
  * <p>
- * <b>Note:</b> It is mandatory to close the stream after the last byte has been written to it, otherwise the
+ * <strong>Note:</strong> It is mandatory to close the stream after the last byte has been written to it, otherwise the
  * final padding will be omitted and the resulting data will be incomplete/inconsistent.
  * </p>
  * <p>
diff --git a/src/main/java/org/apache/commons/codec/language/Soundex.java b/src/main/java/org/apache/commons/codec/language/Soundex.java
@@ -53,7 +53,7 @@ public class Soundex implements StringEncoder {
      * up the value for the constant values page.)
      * </p>
      * <p>
-     * <b>Note that letters H and W are treated specially.</b>
+     * <strong>Note that letters H and W are treated specially.</strong>
      * They are ignored (after the first letter) and don't act as separators
      * between consonants with the same code.
      * </p>
diff --git a/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java b/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java
@@ -69,7 +69,7 @@
  * splitting on pipe ({@code |}) and indexing under each of these alternatives.
  * </p>
  * <p>
- * <b>Note</b>: this version of the Beider-Morse encoding is equivalent with v3.4 of the reference implementation.
+ * <strong>Note</strong>: this version of the Beider-Morse encoding is equivalent with v3.4 of the reference implementation.
  * </p>
  * @see <a href="https://stevemorse.org/phonetics/bmpm.htm">Beider-Morse Phonetic Matching</a>
  * @see <a href="https://stevemorse.org/phoneticinfo.htm">Reference implementation</a>
diff --git a/src/main/java/org/apache/commons/codec/language/bm/Lang.java b/src/main/java/org/apache/commons/codec/language/bm/Lang.java
@@ -54,19 +54,19 @@
  * The format of these resources is the following:
  * </p>
  * <ul>
- * <li><b>Rules:</b> whitespace separated strings.
+ * <li><strong>Rules:</strong> whitespace separated strings.
  * There should be 3 columns to each row, and these will be interpreted as:
  * <ol>
  * <li>pattern: a regular expression.</li>
  * <li>languages: a '+'-separated list of languages.</li>
  * <li>acceptOnMatch: 'true' or 'false' indicating if a match rules in or rules out the language.</li>
  * </ol>
  * </li>
- * <li><b>End-of-line comments:</b> Any occurrence of '//' will cause all text following on that line to be
+ * <li><strong>End-of-line comments:</strong> Any occurrence of '//' will cause all text following on that line to be
  * discarded as a comment.</li>
- * <li><b>Multi-line comments:</b> Any line starting with '/*' will start multi-line commenting mode.
+ * <li><strong>Multi-line comments:</strong> Any line starting with '/*' will start multi-line commenting mode.
  * This will skip all content until a line ending in '*' and '/' is found.</li>
- * <li><b>Blank lines:</b> All blank lines will be skipped.</li>
+ * <li><strong>Blank lines:</strong> All blank lines will be skipped.</li>
  * </ul>
  * <p>
  * Port of lang.php
diff --git a/src/main/java/org/apache/commons/codec/language/bm/Languages.java b/src/main/java/org/apache/commons/codec/language/bm/Languages.java
@@ -40,13 +40,13 @@
  * The format of these resources is the following:
  * </p>
  * <ul>
- * <li><b>Language:</b> a single string containing no whitespace</li>
- * <li><b>End-of-line comments:</b> Any occurrence of '//' will cause all text
+ * <li><strong>Language:</strong> a single string containing no whitespace</li>
+ * <li><strong>End-of-line comments:</strong> Any occurrence of '//' will cause all text
  * following on that line to be discarded as a comment.</li>
- * <li><b>Multi-line comments:</b> Any line starting with '/*' will start
+ * <li><strong>Multi-line comments:</strong> Any line starting with '/*' will start
  * multi-line commenting mode. This will skip all content until a line ending in
  * '*' and '/' is found.</li>
- * <li><b>Blank lines:</b> All blank lines will be skipped.</li>
+ * <li><strong>Blank lines:</strong> All blank lines will be skipped.</li>
  * </ul>
  * <p>
  * Ported from language.php
diff --git a/src/main/java/org/apache/commons/codec/language/bm/Rule.java b/src/main/java/org/apache/commons/codec/language/bm/Rule.java
@@ -64,7 +64,7 @@
  * The format of these resources is the following:
  * </p>
  * <ul>
- * <li><b>Rules:</b> whitespace separated, double-quoted strings. There should be 4 columns to each row, and these
+ * <li><strong>Rules:</strong> whitespace separated, double-quoted strings. There should be 4 columns to each row, and these
  * will be interpreted as:
  * <ol>
  * <li>pattern</li>
@@ -73,11 +73,11 @@
  * <li>phoneme</li>
  * </ol>
  * </li>
- * <li><b>End-of-line comments:</b> Any occurrence of '//' will cause all text following on that line to be discarded
+ * <li><strong>End-of-line comments:</strong> Any occurrence of '//' will cause all text following on that line to be discarded
  * as a comment.</li>
- * <li><b>Multi-line comments:</b> Any line starting with '/*' will start multi-line commenting mode. This will skip
+ * <li><strong>Multi-line comments:</strong> Any line starting with '/*' will start multi-line commenting mode. This will skip
  * all content until a line ending in '*' and '/' is found.</li>
- * <li><b>Blank lines:</b> All blank lines will be skipped.</li>
+ * <li><strong>Blank lines:</strong> All blank lines will be skipped.</li>
  * </ul>
  *
  * @since 1.6
diff --git a/src/test/java/org/apache/commons/codec/language/bm/PhoneticEnginePerformanceTest.java b/src/test/java/org/apache/commons/codec/language/bm/PhoneticEnginePerformanceTest.java
@@ -40,7 +40,7 @@
  * <li>Time for encoding 80,000 times the input 'Angelo': 33,039 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 32,297 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 32,857 millis.</li>
- * <li>Time for encoding 80,000 times the input 'Angelo': <b>31,561 millis.</b></li>
+ * <li>Time for encoding 80,000 times the input 'Angelo': <strong>31,561 millis.</strong></li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 32,665 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 32,215 millis.</li>
  * </ol>
@@ -53,7 +53,7 @@
  * <li>Time for encoding 80,000 times the input 'Angelo': 18,196 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 13,858 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 13,644 millis.</li>
- * <li>Time for encoding 80,000 times the input 'Angelo': <b>13,591 millis.</b></li>
+ * <li>Time for encoding 80,000 times the input 'Angelo': <strong>13,591 millis.</strong></li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 13,861 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 13,696 millis.</li>
  * </ol>
@@ -67,7 +67,7 @@
  * </p>
  * <ol>
  * <li>Time for encoding 80,000 times the input 'Angelo': 13,547 millis.</li>
- * <li>Time for encoding 80,000 times the input 'Angelo': <b>13,501 millis.</b></li>
+ * <li>Time for encoding 80,000 times the input 'Angelo': <strong>13,501 millis.</strong></li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 13,528 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 17,110 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 13,910 millis.</li>
@@ -85,7 +85,7 @@
  * <li>Time for encoding 80,000 times the input 'Angelo': 13,724 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 13,451 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 13,742 millis.</li>
- * <li>Time for encoding 80,000 times the input 'Angelo': <b>13,186 millis.</b></li>
+ * <li>Time for encoding 80,000 times the input 'Angelo': <strong>13,186 millis.</strong></li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 13,600 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 16,405 millis.</li>
  * </ol>
@@ -98,7 +98,7 @@
  * <ol>
  * <li>Time for encoding 80,000 times the input 'Angelo': 13,133 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 13,064 millis.</li>
- * <li>Time for encoding 80,000 times the input 'Angelo': <b>12,838 millis.</b></li>
+ * <li>Time for encoding 80,000 times the input 'Angelo': <strong>12,838 millis.</strong></li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 12,970 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 13,122 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 13,293 millis.</li>
@@ -110,7 +110,7 @@
  * <li>Time for encoding 80,000 times the input 'Angelo': 11,576 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 11,506 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 11,361 millis.</li>
- * <li>Time for encoding 80,000 times the input 'Angelo': <b>11,142 millis.</b></li>
+ * <li>Time for encoding 80,000 times the input 'Angelo': <strong>11,142 millis.</strong></li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 11,430 millis.</li>
  * <li>Time for encoding 80,000 times the input 'Angelo': 11,297 millis.</li>
  * </ol>
