(commons-text) branch master updated: Javadoc: Use semantic tag instead of style tag

ggregory Fri, 15 Nov 2024 08:48:37 -0800

This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-text.git
The following commit(s) were added to refs/heads/master by this push: new ca1f253b Javadoc: Use semantic tag instead of style tag ca1f253b is described below commit ca1f253b6541bddd458a0a4dba52375acce7f021 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Fri Nov 15 11:48:26 2024 -0500 Javadoc: Use semantic tag instead of style tag --- .../apache/commons/text/ExtendedMessageFormat.java | 8 ++--- .../org/apache/commons/text/StrSubstitutor.java | 18 ++++++------ .../org/apache/commons/text/StringEscapeUtils.java | 4 +-- .../org/apache/commons/text/StringSubstitutor.java | 16 +++++----- .../commons/text/lookup/ConstantStringLookup.java | 4 +-- .../commons/text/lookup/DnsStringLookup.java | 8 ++--- .../text/lookup/InetAddressStringLookup.java | 6 ++-- .../text/lookup/InterpolatorStringLookup.java | 2 +- .../text/lookup/JavaPlatformStringLookup.java | 24 +++++++-------- .../commons/text/lookup/StringLookupFactory.java | 34 +++++++++++----------- .../text/similarity/LongestCommonSubsequence.java | 2 +- .../LongestCommonSubsequenceDistance.java | 2 +- 12 files changed, 64 insertions(+), 64 deletions(-) diff --git a/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java b/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java index 60d63e94..87b52510 100644 --- a/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java +++ b/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java @@ -39,9 +39,9 @@ import org.apache.commons.text.matcher.StringMatcherFactory; * parsed from the message pattern. In this way custom patterns can be specified, * and the formats supported by {@link java.text.MessageFormat} can be overridden * at the format and/or format style level (see MessageFormat). A "format element" - * embedded in the message pattern is specified (()? signifies optionality): - * {@code {}argument-number({@code ,}format-name - * ({@code ,}format-style)?)?{@code }} + * embedded in the message pattern is specified (()? signifies optionality): + * {@code {}argument-number({@code ,}format-name + * ({@code ,}format-style)?)?{@code }} * * * format-name and format-style values are trimmed of surrounding whitespace @@ -52,7 +52,7 @@ import org.apache.commons.text.matcher.StringMatcherFactory; * found is used for this format element. * * - * NOTICE: The various subformat mutator methods are considered unnecessary; they exist on the parent + * NOTICE: The various subformat mutator methods are considered unnecessary; they exist on the parent * class to allow the type of customization which it is the job of this class to provide in * a configurable fashion. These methods have thus been disabled and will throw * {@code UnsupportedOperationException} if called. diff --git a/src/main/java/org/apache/commons/text/StrSubstitutor.java b/src/main/java/org/apache/commons/text/StrSubstitutor.java index cf498105..04c51327 100644 --- a/src/main/java/org/apache/commons/text/StrSubstitutor.java +++ b/src/main/java/org/apache/commons/text/StrSubstitutor.java @@ -117,8 +117,8 @@ import org.apache.commons.lang3.Validate; * {@code StrSubstitutor} supports this recursive substitution in variable * names, but it has to be enabled explicitly by setting the * {@link #setEnableSubstitutionInVariables(boolean) enableSubstitutionInVariables} - * property to true. - * This class is not thread safe. + * property to true. + * This class is not thread safe. * * @since 1.0 * @deprecated Deprecated as of 1.3, use {@link StringSubstitutor} instead. This class will be removed in 2.0. @@ -473,7 +473,7 @@ public class StrSubstitutor { /** * Returns a flag whether substitution is disabled in variable values.If set to - * true, the values of variables can contain other variables will not be + * true, the values of variables can contain other variables will not be * processed and substituted original variable is evaluated, e.g. * <pre> * Map<String, String> valuesMap = new HashMap<>(); @@ -865,7 +865,7 @@ public class StrSubstitutor { * @param buf the buffer where the substitution is occurring, not null * @param startPos the start position of the variable including the prefix, valid * @param endPos the end position of the variable including the suffix, valid - * @return The variable's value or null if the variable is unknown + * @return The variable's value or null if the variable is unknown */ protected String resolveVariable(final String variableName, final StrBuilder buf, @@ -891,9 +891,9 @@ public class StrSubstitutor { /** * Sets a flag whether substitution is done in variable names. If set to - * true, the names of variables can contain other variables which are + * true, the names of variables can contain other variables which are * processed first before the original variable is evaluated, e.g. - * {@code ${jre-${java.version}}}. The default value is false. + * {@code ${jre-${java.version}}}. The default value is false. * * @param enableSubstitutionInVariables the new value of the flag */ @@ -915,12 +915,12 @@ public class StrSubstitutor { /** * Sets a flag controlling whether escapes are preserved during - * substitution. If set to true, the escape character is retained + * substitution. If set to true, the escape character is retained * during substitution (e.g. {@code $${this-is-escaped}} remains - * {@code $${this-is-escaped}}). If set to false, the escape + * {@code $${this-is-escaped}}). If set to false, the escape * character is removed during substitution (e.g. * {@code $${this-is-escaped}} becomes - * {@code ${this-is-escaped}}). The default value is false + * {@code ${this-is-escaped}}). The default value is false * * @param preserveEscapes true if escapes are to be preserved */ diff --git a/src/main/java/org/apache/commons/text/StringEscapeUtils.java b/src/main/java/org/apache/commons/text/StringEscapeUtils.java index 5a531bd8..6ad11c9c 100644 --- a/src/main/java/org/apache/commons/text/StringEscapeUtils.java +++ b/src/main/java/org/apache/commons/text/StringEscapeUtils.java @@ -530,7 +530,7 @@ public class StringEscapeUtils { * output string: He didn\'t say, \"Stop!\" * </pre> * - * Security Note. We only provide backslash escaping in this method. For example, {@code '\"'} has the output + * Security Note. We only provide backslash escaping in this method. For example, {@code '\"'} has the output * {@code '\\\"'} which could result in potential issues in the case where the string being escaped is being used * in an HTML tag like {@code <select onmouseover="..." />}. If you wish to have more rigorous string escaping, you * may consider the @@ -701,7 +701,7 @@ public class StringEscapeUtils { /** * Escapes the characters in a {@code String} using XSI rules. * - * Beware! In most cases you don't want to escape shell commands but use multi-argument + * Beware! In most cases you don't want to escape shell commands but use multi-argument * methods provided by {@link ProcessBuilder} or {@link Runtime#exec(String[])} * instead. * diff --git a/src/main/java/org/apache/commons/text/StringSubstitutor.java b/src/main/java/org/apache/commons/text/StringSubstitutor.java index 9973d99f..2637fc56 100644 --- a/src/main/java/org/apache/commons/text/StringSubstitutor.java +++ b/src/main/java/org/apache/commons/text/StringSubstitutor.java @@ -212,7 +212,7 @@ import org.apache.commons.text.matcher.StringMatcherFactory; * * <h2>Thread Safety</h2> * - * This class is not thread safe. + * This class is not thread safe. * * * @since 1.3 @@ -734,7 +734,7 @@ public class StringSubstitutor { } /** - * Returns a flag whether substitution is disabled in variable values.If set to true, the values of variables + * Returns a flag whether substitution is disabled in variable values.If set to true, the values of variables * can contain other variables will not be processed and substituted original variable is evaluated, e.g. * * <pre> @@ -1144,7 +1144,7 @@ public class StringSubstitutor { * @param buf the buffer where the substitution is occurring, not null * @param startPos the start position of the variable including the prefix, valid * @param endPos the end position of the variable including the suffix, valid - * @return The variable's value or null if the variable is unknown + * @return The variable's value or null if the variable is unknown */ protected String resolveVariable(final String variableName, final TextStringBuilder buf, final int startPos, final int endPos) { @@ -1167,9 +1167,9 @@ public class StringSubstitutor { } /** - * Sets a flag whether substitution is done in variable names. If set to true, the names of variables can + * Sets a flag whether substitution is done in variable names. If set to true, the names of variables can * contain other variables which are processed first before the original variable is evaluated, e.g. - * {@code ${jre-${java.version}}}. The default value is false. + * {@code ${jre-${java.version}}}. The default value is false. * * @param enableSubstitutionInVariables the new value of the flag * @return this, to enable chaining @@ -1203,10 +1203,10 @@ public class StringSubstitutor { } /** - * Sets a flag controlling whether escapes are preserved during substitution. If set to true, the escape + * Sets a flag controlling whether escapes are preserved during substitution. If set to true, the escape * character is retained during substitution (e.g. {@code $${this-is-escaped}} remains {@code $${this-is-escaped}}). - * If set to false, the escape character is removed during substitution (e.g. {@code $${this-is-escaped}} - * becomes {@code ${this-is-escaped}}). The default value is false + * If set to false, the escape character is removed during substitution (e.g. {@code $${this-is-escaped}} + * becomes {@code ${this-is-escaped}}). The default value is false * * @param preserveEscapes true if escapes are to be preserved * @return this, to enable chaining diff --git a/src/main/java/org/apache/commons/text/lookup/ConstantStringLookup.java b/src/main/java/org/apache/commons/text/lookup/ConstantStringLookup.java index bbf6df28..c8ebe018 100644 --- a/src/main/java/org/apache/commons/text/lookup/ConstantStringLookup.java +++ b/src/main/java/org/apache/commons/text/lookup/ConstantStringLookup.java @@ -31,7 +31,7 @@ import org.apache.commons.text.StringSubstitutor; * 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 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 the fully qualified class - * name and the name of the constant (i.e. static final) member field. Then the class is loaded and the field's + * name and the name of the constant (i.e. static final) member field. Then the class is loaded and the field's * value is obtained using reflection. * * @@ -102,7 +102,7 @@ class ConstantStringLookup extends AbstractStringLookup { * the field. * * @param key the name of the variable to be resolved - * @return The value of this variable or null if it cannot be resolved + * @return The value of this variable or null if it cannot be resolved */ @Override public synchronized String lookup(final String key) { diff --git a/src/main/java/org/apache/commons/text/lookup/DnsStringLookup.java b/src/main/java/org/apache/commons/text/lookup/DnsStringLookup.java index d9e6f9df..6cb7757f 100644 --- a/src/main/java/org/apache/commons/text/lookup/DnsStringLookup.java +++ b/src/main/java/org/apache/commons/text/lookup/DnsStringLookup.java @@ -27,13 +27,13 @@ import org.apache.commons.text.StringSubstitutor; * The lookup keys are: * * <ul> - * <li>name|address: for the host name, for example {@code "name|93.184.216.34"} -> + * <li>name|address: for the host name, for example {@code "name|93.184.216.34"} -> * {@code "example.com"}.</li> - * <li>canonical-name|address: for the canonical host name, for example {@code "name|93.184.216.34"} -> + * <li>canonical-name|address: for the canonical host name, for example {@code "name|93.184.216.34"} -> * {@code "example.com"}.</li> - * <li>address|hostname: for the host address, for example {@code "address|example.com"} -> + * <li>address|hostname: for the host address, for example {@code "address|example.com"} -> * {@code "93.184.216.34"}.</li> - * <li>address: same as {@code address|hostname}.</li> + * <li>address: same as {@code address|hostname}.</li> * </ul> * * diff --git a/src/main/java/org/apache/commons/text/lookup/InetAddressStringLookup.java b/src/main/java/org/apache/commons/text/lookup/InetAddressStringLookup.java index 395d1d53..07819b09 100644 --- a/src/main/java/org/apache/commons/text/lookup/InetAddressStringLookup.java +++ b/src/main/java/org/apache/commons/text/lookup/InetAddressStringLookup.java @@ -31,9 +31,9 @@ import org.apache.commons.lang3.function.FailableSupplier; * The lookup keys are: * * <ul> - * <li>name: for the local host name, for example {@code EXAMPLE}.</li> - * <li>canonical-name: for the local canonical host name, for example {@code EXAMPLE.apache.org}.</li> - * <li>address: for the local host address, for example {@code 192.168.56.1}.</li> + * <li>name: for the local host name, for example {@code EXAMPLE}.</li> + * <li>canonical-name: for the local canonical host name, for example {@code EXAMPLE.apache.org}.</li> + * <li>address: for the local host address, for example {@code 192.168.56.1}.</li> * </ul> * * @since 1.3 diff --git a/src/main/java/org/apache/commons/text/lookup/InterpolatorStringLookup.java b/src/main/java/org/apache/commons/text/lookup/InterpolatorStringLookup.java index b29c34bd..0fa7b780 100644 --- a/src/main/java/org/apache/commons/text/lookup/InterpolatorStringLookup.java +++ b/src/main/java/org/apache/commons/text/lookup/InterpolatorStringLookup.java @@ -109,7 +109,7 @@ final class InterpolatorStringLookup extends AbstractStringLookup { * associated lookup object cannot resolve this variable, the default lookup object will be used. * * @param key the name of the variable whose value is to be looked up - * @return The value of this variable or null if it cannot be resolved + * @return The value of this variable or null if it cannot be resolved */ @Override public String lookup(String key) { diff --git a/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java b/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java index c2febf9f..0e21330d 100644 --- a/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java +++ b/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java @@ -27,12 +27,12 @@ import org.apache.commons.text.StringSubstitutor; * The lookup keys with examples are: * * <ul> - * <li>version: "Java version 1.8.0_181"</li> - * <li>runtime: "Java(TM) SE Runtime Environment (build 1.8.0_181-b13) from Oracle Corporation"</li> - * <li>vm: "Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)"</li> - * <li>os: "Windows 10 10.0, architecture: amd64-64"</li> - * <li>hardware: "processors: 4, architecture: amd64-64, instruction sets: amd64"</li> - * <li>locale: "default locale: en_US, platform encoding: iso-8859-1"</li> + * <li>version: "Java version 1.8.0_181"</li> + * <li>runtime: "Java(TM) SE Runtime Environment (build 1.8.0_181-b13) from Oracle Corporation"</li> + * <li>vm: "Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)"</li> + * <li>os: "Windows 10 10.0, architecture: amd64-64"</li> + * <li>hardware: "processors: 4, architecture: amd64-64, instruction sets: amd64"</li> + * <li>locale: "default locale: en_US, platform encoding: iso-8859-1"</li> * </ul> * * @@ -180,12 +180,12 @@ final class JavaPlatformStringLookup extends AbstractStringLookup { * The lookup keys with examples are: * * <ul> - * <li>version: "Java version 1.8.0_181"</li> - * <li>runtime: "Java(TM) SE Runtime Environment (build 1.8.0_181-b13) from Oracle Corporation"</li> - * <li>vm: "Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)"</li> - * <li>os: "Windows 10 10.0, architecture: amd64-64"</li> - * <li>hardware: "processors: 4, architecture: amd64-64, instruction sets: amd64"</li> - * <li>locale: "default locale: en_US, platform encoding: iso-8859-1"</li> + * <li>version: "Java version 1.8.0_181"</li> + * <li>runtime: "Java(TM) SE Runtime Environment (build 1.8.0_181-b13) from Oracle Corporation"</li> + * <li>vm: "Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)"</li> + * <li>os: "Windows 10 10.0, architecture: amd64-64"</li> + * <li>hardware: "processors: 4, architecture: amd64-64, instruction sets: amd64"</li> + * <li>locale: "default locale: en_US, platform encoding: iso-8859-1"</li> * </ul> * * @param key the key to be looked up, may be null diff --git a/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java b/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java index f14eb90a..afe374de 100644 --- a/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java +++ b/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java @@ -762,8 +762,8 @@ public final class StringLookupFactory { * * 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 * 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 - * the fully qualified class name and the name of the constant (i.e. static final) member field. Then the class is loaded and the field's value is - * obtained using reflection. + * the fully qualified class name and the name of the constant (i.e. static final) member field. Then the class is loaded and the field's + * value is obtained using reflection. * * * 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 final class StringLookupFactory { /** * Returns the DnsStringLookup singleton instance where the lookup key is one of: * <ul> - * <li>name: for the local host name, for example {@code EXAMPLE} but also {@code EXAMPLE.apache.org}.</li> - * <li>canonical-name: for the local canonical host name, for example {@code EXAMPLE.apache.org}.</li> - * <li>address: for the local host address, for example {@code 192.168.56.1}.</li> + * <li>name: for the local host name, for example {@code EXAMPLE} but also {@code EXAMPLE.apache.org}.</li> + * <li>canonical-name: for the local canonical host name, for example {@code EXAMPLE.apache.org}.</li> + * <li>address: for the local host address, for example {@code 192.168.56.1}.</li> * </ul> * * @@ -1066,12 +1066,12 @@ public final class StringLookupFactory { * The lookup keys with examples are: * * <ul> - * <li>version: "Java version 1.8.0_181"</li> - * <li>runtime: "Java(TM) SE Runtime Environment (build 1.8.0_181-b13) from Oracle Corporation"</li> - * <li>vm: "Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)"</li> - * <li>os: "Windows 10 10.0, architecture: amd64-64"</li> - * <li>hardware: "processors: 4, architecture: amd64-64, instruction sets: amd64"</li> - * <li>locale: "default locale: en_US, platform encoding: iso-8859-1"</li> + * <li>version: "Java version 1.8.0_181"</li> + * <li>runtime: "Java(TM) SE Runtime Environment (build 1.8.0_181-b13) from Oracle Corporation"</li> + * <li>vm: "Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)"</li> + * <li>os: "Windows 10 10.0, architecture: amd64-64"</li> + * <li>hardware: "processors: 4, architecture: amd64-64, instruction sets: amd64"</li> + * <li>locale: "default locale: en_US, platform encoding: iso-8859-1"</li> * </ul> * * @@ -1101,9 +1101,9 @@ public final class StringLookupFactory { /** * Returns the InetAddressStringLookup instance where the lookup key for {@link InetAddress#getLocalHost()} is one of: * <ul> - * <li>name: for the local host name, for example {@code EXAMPLE}.</li> - * <li>canonical-name: for the local canonical host name, for example {@code EXAMPLE.apache.org}.</li> - * <li>address: for the local host address, for example {@code 192.168.56.1}.</li> + * <li>name: for the local host name, for example {@code EXAMPLE}.</li> + * <li>canonical-name: for the local canonical host name, for example {@code EXAMPLE.apache.org}.</li> + * <li>address: for the local host address, for example {@code 192.168.56.1}.</li> * </ul> * * @@ -1133,9 +1133,9 @@ public final class StringLookupFactory { /** * Returns the InetAddressStringLookup instance where the lookup key for {@link InetAddress#getLoopbackAddress()} is one of: * <ul> - * <li>name: for the local host name, for example {@code EXAMPLE}.</li> - * <li>canonical-name: for the local canonical host name, for example {@code EXAMPLE.apache.org}.</li> - * <li>address: for the local host address, for example {@code 192.168.56.1}.</li> + * <li>name: for the local host name, for example {@code EXAMPLE}.</li> + * <li>canonical-name: for the local canonical host name, for example {@code EXAMPLE.apache.org}.</li> + * <li>address: for the local host address, for example {@code 192.168.56.1}.</li> * </ul> * * diff --git a/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequence.java b/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequence.java index 993c7ba0..b2ae4c8e 100644 --- a/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequence.java +++ b/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequence.java @@ -40,7 +40,7 @@ package org.apache.commons.text.similarity; * For further reading see: * <ul> * <li> - * Lothaire, M. Applied combinatorics on words. New York: Cambridge U Press, 2005. 12-13 + * Lothaire, M. Applied combinatorics on words. New York: Cambridge U Press, 2005. 12-13 * </li> * <li> * D. S. Hirschberg, "A linear space algorithm for computing maximal common subsequences," CACM, 1975, pp. 341--343. diff --git a/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequenceDistance.java b/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequenceDistance.java index 6bf3d0bc..b66ad472 100644 --- a/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequenceDistance.java +++ b/src/main/java/org/apache/commons/text/similarity/LongestCommonSubsequenceDistance.java @@ -30,7 +30,7 @@ package org.apache.commons.text.similarity; * * For further reading see: * - * Lothaire, M. Applied combinatorics on words. New York: Cambridge U Press, 2005. 12-13 + * Lothaire, M. Applied combinatorics on words. New York: Cambridge U Press, 2005. 12-13 * * @since 1.0 */

Previous message

View by thread

View by date

Next message

Reply via email to