Skip to content

Commit ca1f253

Browse files
garydgregorygarydgregory
committed
Javadoc: Use semantic tag <strong> instead of style tag <b>
1 parent f514488 commit ca1f253

12 files changed

+64
-64
lines changed

‎src/main/java/org/apache/commons/text/ExtendedMessageFormat.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@
3939
* parsed from the message pattern. In this way custom patterns can be specified,
4040
* and the formats supported by {@link java.text.MessageFormat} can be overridden
4141
* at the format and/or format style level (see MessageFormat). A "format element"
42-
* embedded in the message pattern is specified (<b>()?</b> signifies optionality):<br>
43-
* {@code {}<em>argument-number</em><b>(</b>{@code ,}<em>format-name</em><b>
44-
* (</b>{@code ,}<em>format-style</em><b>)?)?</b>{@code }}
42+
* embedded in the message pattern is specified (<strong>()?</strong> signifies optionality):<br>
43+
* {@code {}<em>argument-number</em><strong>(</strong>{@code ,}<em>format-name</em><b>
44+
* (</b>{@code ,}<em>format-style</em><strong>)?)?</strong>{@code }}
4545
*
4646
* <p>
4747
* <em>format-name</em> and <em>format-style</em> values are trimmed of surrounding whitespace
@@ -52,7 +52,7 @@
5252
* found is used for this format element.
5353
* </p>
5454
*
55-
* <p><b>NOTICE:</b> The various subformat mutator methods are considered unnecessary; they exist on the parent
55+
* <p><strong>NOTICE:</strong> The various subformat mutator methods are considered unnecessary; they exist on the parent
5656
* class to allow the type of customization which it is the job of this class to provide in
5757
* a configurable fashion. These methods have thus been disabled and will throw
5858
* {@code UnsupportedOperationException} if called.

‎src/main/java/org/apache/commons/text/StrSubstitutor.java‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@
117117
* {@code StrSubstitutor} supports this recursive substitution in variable
118118
* names, but it has to be enabled explicitly by setting the
119119
* {@link #setEnableSubstitutionInVariables(boolean) enableSubstitutionInVariables}
120-
* property to <b>true</b>.
121-
* <p>This class is <b>not</b> thread safe.</p>
120+
* property to <strong>true</strong>.
121+
* <p>This class is <strong>not</strong> thread safe.</p>
122122
*
123123
* @since 1.0
124124
* @deprecated Deprecated as of 1.3, use {@link StringSubstitutor} instead. This class will be removed in 2.0.
@@ -473,7 +473,7 @@ public StrMatcher getVariableSuffixMatcher() {
473473

474474
/**
475475
* Returns a flag whether substitution is disabled in variable values.If set to
476-
* <b>true</b>, the values of variables can contain other variables will not be
476+
* <strong>true</strong>, the values of variables can contain other variables will not be
477477
* processed and substituted original variable is evaluated, e.g.
478478
* <pre>
479479
* Map&lt;String, String&gt; valuesMap = new HashMap&lt;&gt;();
@@ -865,7 +865,7 @@ public boolean replaceIn(final StringBuilder source, final int offset, final int
865865
* @param buf the buffer where the substitution is occurring, not null
866866
* @param startPos the start position of the variable including the prefix, valid
867867
* @param endPos the end position of the variable including the suffix, valid
868-
* @return The variable's value or <b>null</b> if the variable is unknown
868+
* @return The variable's value or <strong>null</strong> if the variable is unknown
869869
*/
870870
protected String resolveVariable(final String variableName,
871871
final StrBuilder buf,
@@ -891,9 +891,9 @@ public void setDisableSubstitutionInValues(final boolean disableSubstitutionInVa
891891

892892
/**
893893
* Sets a flag whether substitution is done in variable names. If set to
894-
* <b>true</b>, the names of variables can contain other variables which are
894+
* <strong>true</strong>, the names of variables can contain other variables which are
895895
* processed first before the original variable is evaluated, e.g.
896-
* {@code ${jre-${java.version}}}. The default value is <b>false</b>.
896+
* {@code ${jre-${java.version}}}. The default value is <strong>false</strong>.
897897
*
898898
* @param enableSubstitutionInVariables the new value of the flag
899899
*/
@@ -915,12 +915,12 @@ public void setEscapeChar(final char escapeCharacter) {
915915

916916
/**
917917
* Sets a flag controlling whether escapes are preserved during
918-
* substitution. If set to <b>true</b>, the escape character is retained
918+
* substitution. If set to <strong>true</strong>, the escape character is retained
919919
* during substitution (e.g. {@code $${this-is-escaped}} remains
920-
* {@code $${this-is-escaped}}). If set to <b>false</b>, the escape
920+
* {@code $${this-is-escaped}}). If set to <strong>false</strong>, the escape
921921
* character is removed during substitution (e.g.
922922
* {@code $${this-is-escaped}} becomes
923-
* {@code ${this-is-escaped}}). The default value is <b>false</b>
923+
* {@code ${this-is-escaped}}). The default value is <strong>false</strong>
924924
*
925925
* @param preserveEscapes true if escapes are to be preserved
926926
*/

‎src/main/java/org/apache/commons/text/StringEscapeUtils.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -530,7 +530,7 @@ public static String escapeCsv(final String input) {
530530
* output string: He didn\'t say, \"Stop!\"
531531
* </pre>
532532
*
533-
* <b>Security Note.</b> We only provide backslash escaping in this method. For example, {@code '\"'} has the output
533+
* <strong>Security Note.</strong> We only provide backslash escaping in this method. For example, {@code '\"'} has the output
534534
* {@code '\\\"'} which could result in potential issues in the case where the string being escaped is being used
535535
* in an HTML tag like {@code <select onmouseover="..." />}. If you wish to have more rigorous string escaping, you
536536
* may consider the
@@ -701,7 +701,7 @@ public static String escapeXml11(final String input) {
701701
/**
702702
* Escapes the characters in a {@code String} using XSI rules.
703703
*
704-
* <p><b>Beware!</b> In most cases you don't want to escape shell commands but use multi-argument
704+
* <p><strong>Beware!</strong> In most cases you don't want to escape shell commands but use multi-argument
705705
* methods provided by {@link ProcessBuilder} or {@link Runtime#exec(String[])}
706706
* instead.</p>
707707
*

‎src/main/java/org/apache/commons/text/StringSubstitutor.java‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@
212212
*
213213
* <h2>Thread Safety</h2>
214214
* <p>
215-
* This class is <b>not</b> thread safe.
215+
* This class is <strong>not</strong> thread safe.
216216
* </p>
217217
*
218218
* @since 1.3
@@ -734,7 +734,7 @@ public StringMatcher getVariableSuffixMatcher() {
734734
}
735735

736736
/**
737-
* Returns a flag whether substitution is disabled in variable values.If set to <b>true</b>, the values of variables
737+
* Returns a flag whether substitution is disabled in variable values.If set to <strong>true</strong>, the values of variables
738738
* can contain other variables will not be processed and substituted original variable is evaluated, e.g.
739739
*
740740
* <pre>
@@ -1144,7 +1144,7 @@ public boolean replaceIn(final TextStringBuilder source, final int offset, final
11441144
* @param buf the buffer where the substitution is occurring, not null
11451145
* @param startPos the start position of the variable including the prefix, valid
11461146
* @param endPos the end position of the variable including the suffix, valid
1147-
* @return The variable's value or <b>null</b> if the variable is unknown
1147+
* @return The variable's value or <strong>null</strong> if the variable is unknown
11481148
*/
11491149
protected String resolveVariable(final String variableName, final TextStringBuilder buf, final int startPos,
11501150
final int endPos) {
@@ -1167,9 +1167,9 @@ public StringSubstitutor setDisableSubstitutionInValues(final boolean disableSub
11671167
}
11681168

11691169
/**
1170-
* Sets a flag whether substitution is done in variable names. If set to <b>true</b>, the names of variables can
1170+
* Sets a flag whether substitution is done in variable names. If set to <strong>true</strong>, the names of variables can
11711171
* contain other variables which are processed first before the original variable is evaluated, e.g.
1172-
* {@code ${jre-${java.version}}}. The default value is <b>false</b>.
1172+
* {@code ${jre-${java.version}}}. The default value is <strong>false</strong>.
11731173
*
11741174
* @param enableSubstitutionInVariables the new value of the flag
11751175
* @return this, to enable chaining
@@ -1203,10 +1203,10 @@ public StringSubstitutor setEscapeChar(final char escapeChar) {
12031203
}
12041204

12051205
/**
1206-
* Sets a flag controlling whether escapes are preserved during substitution. If set to <b>true</b>, the escape
1206+
* Sets a flag controlling whether escapes are preserved during substitution. If set to <strong>true</strong>, the escape
12071207
* character is retained during substitution (e.g. {@code $${this-is-escaped}} remains {@code $${this-is-escaped}}).
1208-
* If set to <b>false</b>, the escape character is removed during substitution (e.g. {@code $${this-is-escaped}}
1209-
* becomes {@code ${this-is-escaped}}). The default value is <b>false</b>
1208+
* If set to <strong>false</strong>, the escape character is removed during substitution (e.g. {@code $${this-is-escaped}}
1209+
* becomes {@code ${this-is-escaped}}). The default value is <strong>false</strong>
12101210
*
12111211
* @param preserveEscapes true if escapes are to be preserved
12121212
* @return this, to enable chaining

‎src/main/java/org/apache/commons/text/lookup/ConstantStringLookup.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
* Sometimes it is necessary in a configuration file to refer to a constant defined in a class. This can be done with
3232
* this lookup implementation. Variable names must be in the format {@code apackage.AClass.AFIELD}. The
3333
* {@code lookup(String)} method will split the passed in string at the last dot, separating the fully qualified class
34-
* name and the name of the constant (i.e. <b>static final</b>) member field. Then the class is loaded and the field's
34+
* name and the name of the constant (i.e. <strong>static final</strong>) member field. Then the class is loaded and the field's
3535
* value is obtained using reflection.
3636
* </p>
3737
* <p>
@@ -102,7 +102,7 @@ protected Class<?> fetchClass(final String className) throws ClassNotFoundExcept
102102
* the field.
103103
*
104104
* @param key the name of the variable to be resolved
105-
* @return The value of this variable or <b>null</b> if it cannot be resolved
105+
* @return The value of this variable or <strong>null</strong> if it cannot be resolved
106106
*/
107107
@Override
108108
public synchronized String lookup(final String key) {

‎src/main/java/org/apache/commons/text/lookup/DnsStringLookup.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@
2727
* The lookup keys are:
2828
* </p>
2929
* <ul>
30-
* <li><b>name|<em>address</em></b>: for the host name, for example {@code "name|93.184.216.34"} ->
30+
* <li><strong>name|<em>address</em></strong>: for the host name, for example {@code "name|93.184.216.34"} ->
3131
* {@code "example.com"}.</li>
32-
* <li><b>canonical-name|<em>address</em></b>: for the canonical host name, for example {@code "name|93.184.216.34"} ->
32+
* <li><strong>canonical-name|<em>address</em></strong>: for the canonical host name, for example {@code "name|93.184.216.34"} ->
3333
* {@code "example.com"}.</li>
34-
* <li><b>address|<em>hostname</em></b>: for the host address, for example {@code "address|example.com"} ->
34+
* <li><strong>address|<em>hostname</em></strong>: for the host address, for example {@code "address|example.com"} ->
3535
* {@code "93.184.216.34"}.</li>
36-
* <li><b><em>address</em></b>: same as {@code address|hostname}.</li>
36+
* <li><strong><em>address</em></strong>: same as {@code address|hostname}.</li>
3737
* </ul>
3838
*
3939
* <p>

‎src/main/java/org/apache/commons/text/lookup/InetAddressStringLookup.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@
3131
* The lookup keys are:
3232
* </p>
3333
* <ul>
34-
* <li><b>name</b>: for the local host name, for example {@code EXAMPLE}.</li>
35-
* <li><b>canonical-name</b>: for the local canonical host name, for example {@code EXAMPLE.apache.org}.</li>
36-
* <li><b>address</b>: for the local host address, for example {@code 192.168.56.1}.</li>
34+
* <li><strong>name</strong>: for the local host name, for example {@code EXAMPLE}.</li>
35+
* <li><strong>canonical-name</strong>: for the local canonical host name, for example {@code EXAMPLE.apache.org}.</li>
36+
* <li><strong>address</strong>: for the local host address, for example {@code 192.168.56.1}.</li>
3737
* </ul>
3838
*
3939
* @since 1.3

‎src/main/java/org/apache/commons/text/lookup/InterpolatorStringLookup.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ public Map<String, StringLookup> getStringLookupMap() {
109109
* associated lookup object cannot resolve this variable, the default lookup object will be used.
110110
*
111111
* @param key the name of the variable whose value is to be looked up
112-
* @return The value of this variable or <b>null</b> if it cannot be resolved
112+
* @return The value of this variable or <strong>null</strong> if it cannot be resolved
113113
*/
114114
@Override
115115
public String lookup(String key) {

‎src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@
2727
* The lookup keys with examples are:
2828
* </p>
2929
* <ul>
30-
* <li><b>version</b>: "Java version 1.8.0_181"</li>
31-
* <li><b>runtime</b>: "Java(TM) SE Runtime Environment (build 1.8.0_181-b13) from Oracle Corporation"</li>
32-
* <li><b>vm</b>: "Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)"</li>
33-
* <li><b>os</b>: "Windows 10 10.0, architecture: amd64-64"</li>
34-
* <li><b>hardware</b>: "processors: 4, architecture: amd64-64, instruction sets: amd64"</li>
35-
* <li><b>locale</b>: "default locale: en_US, platform encoding: iso-8859-1"</li>
30+
* <li><strong>version</strong>: "Java version 1.8.0_181"</li>
31+
* <li><strong>runtime</strong>: "Java(TM) SE Runtime Environment (build 1.8.0_181-b13) from Oracle Corporation"</li>
32+
* <li><strong>vm</strong>: "Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)"</li>
33+
* <li><strong>os</strong>: "Windows 10 10.0, architecture: amd64-64"</li>
34+
* <li><strong>hardware</strong>: "processors: 4, architecture: amd64-64, instruction sets: amd64"</li>
35+
* <li><strong>locale</strong>: "default locale: en_US, platform encoding: iso-8859-1"</li>
3636
* </ul>
3737
*
3838
* <p>
@@ -180,12 +180,12 @@ String getVirtualMachine() {
180180
* The lookup keys with examples are:
181181
* </p>
182182
* <ul>
183-
* <li><b>version</b>: "Java version 1.8.0_181"</li>
184-
* <li><b>runtime</b>: "Java(TM) SE Runtime Environment (build 1.8.0_181-b13) from Oracle Corporation"</li>
185-
* <li><b>vm</b>: "Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)"</li>
186-
* <li><b>os</b>: "Windows 10 10.0, architecture: amd64-64"</li>
187-
* <li><b>hardware</b>: "processors: 4, architecture: amd64-64, instruction sets: amd64"</li>
188-
* <li><b>locale</b>: "default locale: en_US, platform encoding: iso-8859-1"</li>
183+
* <li><strong>version</strong>: "Java version 1.8.0_181"</li>
184+
* <li><strong>runtime</strong>: "Java(TM) SE Runtime Environment (build 1.8.0_181-b13) from Oracle Corporation"</li>
185+
* <li><strong>vm</strong>: "Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)"</li>
186+
* <li><strong>os</strong>: "Windows 10 10.0, architecture: amd64-64"</li>
187+
* <li><strong>hardware</strong>: "processors: 4, architecture: amd64-64, instruction sets: amd64"</li>
188+
* <li><strong>locale</strong>: "default locale: en_US, platform encoding: iso-8859-1"</li>
189189
* </ul>
190190
*
191191
* @param key the key to be looked up, may be null

‎src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -762,8 +762,8 @@ public <R, U> BiStringLookup<U> biFunctionStringLookup(final BiFunction<String,
762762
* <p>
763763
* Sometimes it is necessary in a configuration file to refer to a constant defined in a class. This can be done with this lookup implementation. Variable
764764
* names must be in the format {@code apackage.AClass.AFIELD}. The {@code lookup(String)} method will split the passed in string at the last dot, separating
765-
* the fully qualified class name and the name of the constant (i.e. <b>static final</b>) member field. Then the class is loaded and the field's value is
766-
* obtained using reflection.
765+
* the fully qualified class name and the name of the constant (i.e. <strong>static final</strong>) member field. Then the class is loaded and the field's
766+
* value is obtained using reflection.
767767
* </p>
768768
* <p>
769769
* Once retrieved values are cached for fast access. This class is thread-safe. It can be used as a standard (i.e. global) lookup object and serve multiple
@@ -824,9 +824,9 @@ public StringLookup dateStringLookup() {
824824
/**
825825
* Returns the DnsStringLookup singleton instance where the lookup key is one of:
826826
* <ul>
827-
* <li><b>name</b>: for the local host name, for example {@code EXAMPLE} but also {@code EXAMPLE.apache.org}.</li>
828-
* <li><b>canonical-name</b>: for the local canonical host name, for example {@code EXAMPLE.apache.org}.</li>
829-
* <li><b>address</b>: for the local host address, for example {@code 192.168.56.1}.</li>
827+
* <li><strong>name</strong>: for the local host name, for example {@code EXAMPLE} but also {@code EXAMPLE.apache.org}.</li>
828+
* <li><strong>canonical-name</strong>: for the local canonical host name, for example {@code EXAMPLE.apache.org}.</li>
829+
* <li><strong>address</strong>: for the local host address, for example {@code 192.168.56.1}.</li>
830830
* </ul>
831831
*
832832
* <p>
@@ -1066,12 +1066,12 @@ public StringLookup interpolatorStringLookup(final StringLookup defaultStringLoo
10661066
* The lookup keys with examples are:
10671067
* </p>
10681068
* <ul>
1069-
* <li><b>version</b>: "Java version 1.8.0_181"</li>
1070-
* <li><b>runtime</b>: "Java(TM) SE Runtime Environment (build 1.8.0_181-b13) from Oracle Corporation"</li>
1071-
* <li><b>vm</b>: "Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)"</li>
1072-
* <li><b>os</b>: "Windows 10 10.0, architecture: amd64-64"</li>
1073-
* <li><b>hardware</b>: "processors: 4, architecture: amd64-64, instruction sets: amd64"</li>
1074-
* <li><b>locale</b>: "default locale: en_US, platform encoding: iso-8859-1"</li>
1069+
* <li><strong>version</strong>: "Java version 1.8.0_181"</li>
1070+
* <li><strong>runtime</strong>: "Java(TM) SE Runtime Environment (build 1.8.0_181-b13) from Oracle Corporation"</li>
1071+
* <li><strong>vm</strong>: "Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)"</li>
1072+
* <li><strong>os</strong>: "Windows 10 10.0, architecture: amd64-64"</li>
1073+
* <li><strong>hardware</strong>: "processors: 4, architecture: amd64-64, instruction sets: amd64"</li>
1074+
* <li><strong>locale</strong>: "default locale: en_US, platform encoding: iso-8859-1"</li>
10751075
* </ul>
10761076
*
10771077
* <p>
@@ -1101,9 +1101,9 @@ public StringLookup javaPlatformStringLookup() {
11011101
/**
11021102
* Returns the InetAddressStringLookup instance where the lookup key for {@link InetAddress#getLocalHost()} is one of:
11031103
* <ul>
1104-
* <li><b>name</b>: for the local host name, for example {@code EXAMPLE}.</li>
1105-
* <li><b>canonical-name</b>: for the local canonical host name, for example {@code EXAMPLE.apache.org}.</li>
1106-
* <li><b>address</b>: for the local host address, for example {@code 192.168.56.1}.</li>
1104+
* <li><strong>name</strong>: for the local host name, for example {@code EXAMPLE}.</li>
1105+
* <li><strong>canonical-name</strong>: for the local canonical host name, for example {@code EXAMPLE.apache.org}.</li>
1106+
* <li><strong>address</strong>: for the local host address, for example {@code 192.168.56.1}.</li>
11071107
* </ul>
11081108
*
11091109
* <p>
@@ -1133,9 +1133,9 @@ public StringLookup localHostStringLookup() {
11331133
/**
11341134
* Returns the InetAddressStringLookup instance where the lookup key for {@link InetAddress#getLoopbackAddress()} is one of:
11351135
* <ul>
1136-
* <li><b>name</b>: for the local host name, for example {@code EXAMPLE}.</li>
1137-
* <li><b>canonical-name</b>: for the local canonical host name, for example {@code EXAMPLE.apache.org}.</li>
1138-
* <li><b>address</b>: for the local host address, for example {@code 192.168.56.1}.</li>
1136+
* <li><strong>name</strong>: for the local host name, for example {@code EXAMPLE}.</li>
1137+
* <li><strong>canonical-name</strong>: for the local canonical host name, for example {@code EXAMPLE.apache.org}.</li>
1138+
* <li><strong>address</strong>: for the local host address, for example {@code 192.168.56.1}.</li>
11391139
* </ul>
11401140
*
11411141
* <p>

0 commit comments

Comments
 (0)