Skip to content

Commit 2a51314

Browse files
committed
Javadoc: Use semantic tag <strong> instead of style tag <b>
1 parent 149650a commit 2a51314

24 files changed

+112
-112
lines changed

src/main/java/org/apache/commons/lang3/ClassUtils.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1576,7 +1576,7 @@ private static boolean useFull(final int runAheadTarget, final int source, final
15761576
* </p>
15771577
*
15781578
* @param classes the class array to convert, may be null or empty
1579-
* @return an array which contains for each given class, the primitive class or <b>null</b> if the original class is not
1579+
* @return an array which contains for each given class, the primitive class or <strong>null</strong> if the original class is not
15801580
* a wrapper class. {@code null} if null input. Empty array if an empty array passed in.
15811581
* @see #wrapperToPrimitive(Class)
15821582
* @since 2.4
@@ -1601,11 +1601,11 @@ public static Class<?>[] wrappersToPrimitives(final Class<?>... classes) {
16011601
* <p>
16021602
* This method is the counter part of {@code primitiveToWrapper()}. If the passed in class is a wrapper class for a
16031603
* primitive type, this primitive type will be returned (e.g. {@code Integer.TYPE} for {@code Integer.class}). For other
1604-
* classes, or if the parameter is <b>null</b>, the return value is <b>null</b>.
1604+
* classes, or if the parameter is <strong>null</strong>, the return value is <strong>null</strong>.
16051605
* </p>
16061606
*
1607-
* @param cls the class to convert, may be <b>null</b>
1608-
* @return the corresponding primitive type if {@code cls} is a wrapper class, <b>null</b> otherwise
1607+
* @param cls the class to convert, may be <strong>null</strong>
1608+
* @return the corresponding primitive type if {@code cls} is a wrapper class, <strong>null</strong> otherwise
16091609
* @see #primitiveToWrapper(Class)
16101610
* @since 2.4
16111611
*/

src/main/java/org/apache/commons/lang3/JavaVersion.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ public enum JavaVersion {
201201
* internally.
202202
*
203203
* @param versionStr the Java version as string
204-
* @return the corresponding enumeration constant or <b>null</b> if the
204+
* @return the corresponding enumeration constant or <strong>null</strong> if the
205205
* version is unknown
206206
*/
207207
static JavaVersion get(final String versionStr) {
@@ -278,7 +278,7 @@ static JavaVersion get(final String versionStr) {
278278
* internally.
279279
*
280280
* @param versionStr the Java version as string
281-
* @return the corresponding enumeration constant or <b>null</b> if the
281+
* @return the corresponding enumeration constant or <strong>null</strong> if the
282282
* version is unknown
283283
*/
284284
static JavaVersion getJavaVersion(final String versionStr) {

src/main/java/org/apache/commons/lang3/RandomStringUtils.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
* the algorithms/providers specified in the {@code securerandom.strongAlgorithms} {@link Security} property.
3434
* </p>
3535
* <p>
36-
* Use {@link #insecure()} to get the singleton instance based on {@link ThreadLocalRandom#current()} <b>which is not cryptographically secure</b>. In addition,
36+
* Use {@link #insecure()} to get the singleton instance based on {@link ThreadLocalRandom#current()} <strong>which is not cryptographically secure</strong>. In addition,
3737
* instances do not use a cryptographically random seed unless the {@linkplain System#getProperty system property} {@code java.util.secureRandomSeed} is set to
3838
* {@code true}.
3939
* </p>

src/main/java/org/apache/commons/lang3/RandomUtils.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
* the algorithms/providers specified in the {@code securerandom.strongAlgorithms} {@link Security} property.
3737
* </p>
3838
* <p>
39-
* Use {@link #insecure()} to get the singleton instance based on {@link ThreadLocalRandom#current()} <b>which is not cryptographically secure</b>. In addition,
39+
* Use {@link #insecure()} to get the singleton instance based on {@link ThreadLocalRandom#current()} <strong>which is not cryptographically secure</strong>. In addition,
4040
* instances do not use a cryptographically random seed unless the {@linkplain System#getProperty system property} {@code java.util.secureRandomSeed} is set to
4141
* {@code true}.
4242
* </p>

src/main/java/org/apache/commons/lang3/StringUtils.java

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -37,57 +37,57 @@
3737
* {@code null} safe.
3838
*
3939
* <ul>
40-
* <li><b>IsEmpty/IsBlank</b>
40+
* <li><strong>IsEmpty/IsBlank</strong>
4141
* - checks if a String contains text</li>
42-
* <li><b>Trim/Strip</b>
42+
* <li><strong>Trim/Strip</strong>
4343
* - removes leading and trailing whitespace</li>
44-
* <li><b>Equals/Compare</b>
44+
* <li><strong>Equals/Compare</strong>
4545
* - compares two strings in a null-safe manner</li>
46-
* <li><b>startsWith</b>
46+
* <li><strong>startsWith</strong>
4747
* - check if a String starts with a prefix in a null-safe manner</li>
48-
* <li><b>endsWith</b>
48+
* <li><strong>endsWith</strong>
4949
* - check if a String ends with a suffix in a null-safe manner</li>
50-
* <li><b>IndexOf/LastIndexOf/Contains</b>
50+
* <li><strong>IndexOf/LastIndexOf/Contains</strong>
5151
* - null-safe index-of checks
52-
* <li><b>IndexOfAny/LastIndexOfAny/IndexOfAnyBut/LastIndexOfAnyBut</b>
52+
* <li><strong>IndexOfAny/LastIndexOfAny/IndexOfAnyBut/LastIndexOfAnyBut</strong>
5353
* - index-of any of a set of Strings</li>
54-
* <li><b>ContainsOnly/ContainsNone/ContainsAny</b>
54+
* <li><strong>ContainsOnly/ContainsNone/ContainsAny</strong>
5555
* - checks if String contains only/none/any of these characters</li>
56-
* <li><b>Substring/Left/Right/Mid</b>
56+
* <li><strong>Substring/Left/Right/Mid</strong>
5757
* - null-safe substring extractions</li>
58-
* <li><b>SubstringBefore/SubstringAfter/SubstringBetween</b>
58+
* <li><strong>SubstringBefore/SubstringAfter/SubstringBetween</strong>
5959
* - substring extraction relative to other strings</li>
60-
* <li><b>Split/Join</b>
60+
* <li><strong>Split/Join</strong>
6161
* - splits a String into an array of substrings and vice versa</li>
62-
* <li><b>Remove/Delete</b>
62+
* <li><strong>Remove/Delete</strong>
6363
* - removes part of a String</li>
64-
* <li><b>Replace/Overlay</b>
64+
* <li><strong>Replace/Overlay</strong>
6565
* - Searches a String and replaces one String with another</li>
66-
* <li><b>Chomp/Chop</b>
66+
* <li><strong>Chomp/Chop</strong>
6767
* - removes the last part of a String</li>
68-
* <li><b>AppendIfMissing</b>
68+
* <li><strong>AppendIfMissing</strong>
6969
* - appends a suffix to the end of the String if not present</li>
70-
* <li><b>PrependIfMissing</b>
70+
* <li><strong>PrependIfMissing</strong>
7171
* - prepends a prefix to the start of the String if not present</li>
72-
* <li><b>LeftPad/RightPad/Center/Repeat</b>
72+
* <li><strong>LeftPad/RightPad/Center/Repeat</strong>
7373
* - pads a String</li>
74-
* <li><b>UpperCase/LowerCase/SwapCase/Capitalize/Uncapitalize</b>
74+
* <li><strong>UpperCase/LowerCase/SwapCase/Capitalize/Uncapitalize</strong>
7575
* - changes the case of a String</li>
76-
* <li><b>CountMatches</b>
76+
* <li><strong>CountMatches</strong>
7777
* - counts the number of occurrences of one String in another</li>
78-
* <li><b>IsAlpha/IsNumeric/IsWhitespace/IsAsciiPrintable</b>
78+
* <li><strong>IsAlpha/IsNumeric/IsWhitespace/IsAsciiPrintable</strong>
7979
* - checks the characters in a String</li>
80-
* <li><b>DefaultString</b>
80+
* <li><strong>DefaultString</strong>
8181
* - protects against a null input String</li>
82-
* <li><b>Rotate</b>
82+
* <li><strong>Rotate</strong>
8383
* - rotate (circular shift) a String</li>
84-
* <li><b>Reverse/ReverseDelimited</b>
84+
* <li><strong>Reverse/ReverseDelimited</strong>
8585
* - reverses a String</li>
86-
* <li><b>Abbreviate</b>
86+
* <li><strong>Abbreviate</strong>
8787
* - abbreviates a string using ellipses or another given String</li>
88-
* <li><b>Difference</b>
88+
* <li><strong>Difference</strong>
8989
* - compares Strings and reports on their differences</li>
90-
* <li><b>LevenshteinDistance</b>
90+
* <li><strong>LevenshteinDistance</strong>
9191
* - the number of changes needed to change one String into another</li>
9292
* </ul>
9393
*
@@ -5418,7 +5418,7 @@ public static String normalizeSpace(final String str) {
54185418
/**
54195419
* Finds the n-th index within a CharSequence, handling {@code null}.
54205420
* This method uses {@link String#indexOf(String)} if possible.
5421-
* <p><b>Note:</b> The code starts looking for a match at the start of the target,
5421+
* <p><strong>Note:</strong> The code starts looking for a match at the start of the target,
54225422
* incrementing the starting index by one after each successful match
54235423
* (unless {@code searchStr} is an empty string in which case the position
54245424
* is never incremented and {@code 0} is returned immediately).

src/main/java/org/apache/commons/lang3/Strings.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,12 +263,12 @@ public int lastIndexOf(final CharSequence seq, final CharSequence searchSeq, fin
263263
}
264264

265265
/**
266-
* The <b>C</b>ase-<b>I</b>nsensitive singleton instance.
266+
* The <strong>C</strong>ase-<strong>I</strong>nsensitive singleton instance.
267267
*/
268268
public static final Strings CI = new CiStrings(true);
269269

270270
/**
271-
* The <b>C</b>ase-<b>S</b>nsensitive singleton instance.
271+
* The <strong>C</strong>ase-<strong>S</strong>nsensitive singleton instance.
272272
*/
273273
public static final Strings CS = new CsStrings(true);
274274

src/main/java/org/apache/commons/lang3/SystemUtils.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1911,7 +1911,7 @@ public class SystemUtils {
19111911
* Holds a class name, on Windows XP this is {@code sun.awt.windows.WToolkit}.
19121912
* </p>
19131913
* <p>
1914-
* <b>On platforms without a GUI, this value is {@code null}.</b>
1914+
* <strong>On platforms without a GUI, this value is {@code null}.</strong>
19151915
* </p>
19161916
* <p>
19171917
* Defaults to {@code null} if the runtime does not have security access to read this property or the property does

src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@
9292
* </p>
9393
*
9494
* <p>
95-
* <b>Note:</b> the default {@link ToStringStyle} will only do a "shallow" formatting, i.e. composed objects are not
95+
* <strong>Note:</strong> the default {@link ToStringStyle} will only do a "shallow" formatting, i.e. composed objects are not
9696
* further traversed. To get "deep" formatting, use an instance of {@link RecursiveToStringStyle}.
9797
* </p>
9898
*

src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ public T get() throws ConcurrentException {
271271
/**
272272
* Returns the {@link ExecutorService} that is actually used for executing
273273
* the background task. This method can be called after {@link #start()}
274-
* (before {@code start()} it returns <b>null</b>). If an external executor
274+
* (before {@code start()} it returns <strong>null</strong>). If an external executor
275275
* was set, this is also the active executor. Otherwise this method returns
276276
* the temporary executor that was created by this object.
277277
*
@@ -392,8 +392,8 @@ public final synchronized void setExternalExecutor(
392392
* becomes active and invokes the {@link #initialize()} method in a
393393
* background task. A {@link BackgroundInitializer} can be started exactly
394394
* once. The return value of this method determines whether the start was
395-
* successful: only the first invocation of this method returns <b>true</b>,
396-
* following invocations will return <b>false</b>.
395+
* successful: only the first invocation of this method returns <strong>true</strong>,
396+
* following invocations will return <strong>false</strong>.
397397
*
398398
* @return a flag whether the initializer could be started successfully
399399
*/

src/main/java/org/apache/commons/lang3/concurrent/BasicThreadFactory.java

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ public BasicThreadFactory build() {
140140

141141
/**
142142
* Sets the daemon flag for the new {@link BasicThreadFactory}. If this
143-
* flag is set to <b>true</b> the new thread factory will create daemon
143+
* flag is set to <strong>true</strong> the new thread factory will create daemon
144144
* threads.
145145
*
146146
* @param daemon the value of the daemon flag
@@ -155,9 +155,9 @@ public Builder daemon(final boolean daemon) {
155155
* Sets the naming pattern to be used by the new {@code
156156
* BasicThreadFactory}.
157157
*
158-
* @param namingPattern the naming pattern (must not be <b>null</b>)
158+
* @param namingPattern the naming pattern (must not be <strong>null</strong>)
159159
* @return a reference to this {@link Builder}
160-
* @throws NullPointerException if the naming pattern is <b>null</b>
160+
* @throws NullPointerException if the naming pattern is <strong>null</strong>
161161
*/
162162
public Builder namingPattern(final String namingPattern) {
163163
this.namingPattern = Objects.requireNonNull(namingPattern, "pattern");
@@ -195,9 +195,9 @@ public void reset() {
195195
* new {@link BasicThreadFactory}.
196196
*
197197
* @param exceptionHandler the {@link UncaughtExceptionHandler} (must not be
198-
* <b>null</b>)
198+
* <strong>null</strong>)
199199
* @return a reference to this {@link Builder}
200-
* @throws NullPointerException if the exception handler is <b>null</b>
200+
* @throws NullPointerException if the exception handler is <strong>null</strong>
201201
*/
202202
public Builder uncaughtExceptionHandler(
203203
final Thread.UncaughtExceptionHandler exceptionHandler) {
@@ -210,10 +210,10 @@ public Builder uncaughtExceptionHandler(
210210
* BasicThreadFactory}.
211211
*
212212
* @param factory the wrapped {@link ThreadFactory} (must not be
213-
* <b>null</b>)
213+
* <strong>null</strong>)
214214
* @return a reference to this {@link Builder}
215215
* @throws NullPointerException if the passed in {@link ThreadFactory}
216-
* is <b>null</b>
216+
* is <strong>null</strong>
217217
*/
218218
public Builder wrappedFactory(final ThreadFactory factory) {
219219
this.factory = Objects.requireNonNull(factory, "factory");
@@ -256,9 +256,9 @@ private BasicThreadFactory(final Builder builder) {
256256

257257
/**
258258
* Gets the daemon flag. This flag determines whether newly created
259-
* threads should be daemon threads. If <b>true</b>, this factory object
259+
* threads should be daemon threads. If <strong>true</strong>, this factory object
260260
* calls {@code setDaemon(true)} on the newly created threads. Result can be
261-
* <b>null</b> if no daemon flag was provided at creation time.
261+
* <strong>null</strong> if no daemon flag was provided at creation time.
262262
*
263263
* @return the daemon flag
264264
*/
@@ -268,7 +268,7 @@ public final Boolean getDaemonFlag() {
268268

269269
/**
270270
* Gets the naming pattern for naming newly created threads. Result can
271-
* be <b>null</b> if no naming pattern was provided.
271+
* be <strong>null</strong> if no naming pattern was provided.
272272
*
273273
* @return the naming pattern
274274
*/
@@ -278,7 +278,7 @@ public final String getNamingPattern() {
278278

279279
/**
280280
* Gets the priority of the threads created by this factory. Result can
281-
* be <b>null</b> if no priority was specified.
281+
* be <strong>null</strong> if no priority was specified.
282282
*
283283
* @return the priority for newly created threads
284284
*/
@@ -299,7 +299,7 @@ public long getThreadCount() {
299299

300300
/**
301301
* Gets the {@link UncaughtExceptionHandler} for the threads created by
302-
* this factory. Result can be <b>null</b> if no handler was provided.
302+
* this factory. Result can be <strong>null</strong> if no handler was provided.
303303
*
304304
* @return the {@link UncaughtExceptionHandler}
305305
*/
@@ -309,7 +309,7 @@ public final Thread.UncaughtExceptionHandler getUncaughtExceptionHandler() {
309309

310310
/**
311311
* Gets the wrapped {@link ThreadFactory}. This factory is used for
312-
* actually creating threads. This method never returns <b>null</b>. If no
312+
* actually creating threads. This method never returns <strong>null</strong>. If no
313313
* {@link ThreadFactory} was passed when this object was created, a default
314314
* thread factory is returned.
315315
*

0 commit comments

Comments
 (0)