(maven) branch master updated: Minor Javadoc cleanup (#2126)

[elharo]

This is an automated email from the ASF dual-hosted git repository.

elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven.git


The following commit(s) were added to refs/heads/master by this push:
     new c414d8a5da Minor Javadoc cleanup (#2126)
c414d8a5da is described below

commit c414d8a5da8f2a12eecbd79ac31237b6ffe4c1c5
Author: Elliotte Rusty Harold <elh...@users.noreply.github.com>
AuthorDate: Thu Mar 6 12:03:25 2025 +0000

    Minor Javadoc cleanup (#2126)
    
    * Minor Javadoc fix
---
 .../artifact/versioning/ComparableVersion.java     | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

diff --git 
a/compat/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/ComparableVersion.java
 
b/compat/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/ComparableVersion.java
index f76a4d15ea..4b8f9a1ca0 100644
--- 
a/compat/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/ComparableVersion.java
+++ 
b/compat/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/ComparableVersion.java
@@ -36,25 +36,27 @@
  * <p>
  * Features:
  * <ul>
- * <li>mixing of '<code>-</code>' (hyphen) and '<code>.</code>' (dot) 
separators,</li>
- * <li>transition between characters and digits also constitutes a separator:
+ * <li>Mixing of '<code>-</code>' (hyphen) and '<code>.</code>' (dot) 
separators,</li>
+ * <li>Transition between characters and digits also constitutes a separator:
  *     <code>1.0alpha1 =&gt; [1, [alpha, 1]]</code></li>
- * <li>unlimited number of version components,</li>
- * <li>version components in the text can be digits or strings,</li>
- * <li>strings are checked for well-known qualifiers and the qualifier 
ordering is used for version ordering.
- *     Well-known qualifiers (case-insensitive) are:<ul>
+ * <li>Unlimited number of version components,</li>
+ * <li>Version components in the text can be digits or strings,</li>
+ * <li>Strings are checked for well-known qualifiers, and the qualifier 
ordering is used for version ordering.
+ *     Well-known qualifiers (case-insensitive) are, in order from least to 
greatest:<ol>
  *     <li><code>alpha</code> or <code>a</code></li>
  *     <li><code>beta</code> or <code>b</code></li>
  *     <li><code>milestone</code> or <code>m</code></li>
  *     <li><code>rc</code> or <code>cr</code></li>
  *     <li><code>snapshot</code></li>
- *     <li><code>(the empty string)</code> or <code>ga</code> or 
<code>final</code></li>
+ *     <li><code>ga</code> or <code>final</code></li>
  *     <li><code>sp</code></li>
- *     </ul>
- *     Unknown qualifiers are considered after known qualifiers, with lexical 
order (always case-insensitive),
+ *     </ol>
+ *     Unknown qualifiers are considered after known qualifiers,
+ *     with lexical order (case-insensitive in the English locale).
+ *     <code>ga</code> and <code>final</code> sort the same as not having a 
qualifier.
  *   </li>
  * <li>A hyphen usually precedes a qualifier, and is always less important 
than digits/number. For example
- *   {@code 1.0.RC2 < 1.0-RC3 < 1.0.1}; but prefer {@code 1.0.0-RC1} over 
{@code 1.0.0.RC1}, and more
+ *   {@code 1.0.RC2 < 1.0-RC3 < 1.0.1}; but prefer {@code 1.0.0-RC2} over 
{@code 1.0.0.RC2}, and more
  *   generally: {@code 1.0.X2 < 1.0-X3 < 1.0.1} for any string {@code X}; but 
prefer {@code 1.0.0-X1}
  *   over {@code 1.0.0.X1}.</li>
  * </ul>