Improve Javadoc for a number of version parsing methods.

Author: baron1405

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+### Added
+
+- Improved Javadoc for a number of version parsing methods.
+
 ## [5.0.0] - 2024-10-25
 
 ### Changed

src/main/java/org/cthing/versionparser/gem/GemVersionScheme.java

@@ -40,7 +40,8 @@ private GemVersionScheme() {
     }
 
     /**
-     * Parses a RubyGems version.
+     * Parses a RubyGems version. Refer to the {@link GemVersion} class for detailed information about Gem version
+     * numbers.
      *
      * @param version Version to parse
      * @return Version object corresponding to the specified version string.

src/main/java/org/cthing/versionparser/gradle/GradleVersionScheme.java

@@ -113,7 +113,9 @@ private GradleVersionScheme() {
     }
 
     /**
-     * Parses a Gradle artifact version.
+     * Parses a Gradle artifact version. Refer to the {@link GradleVersion} class and
+     * <a href="https://docs.gradle.org/current/userguide/single_versions.html">Declaring Versions and Ranges</a>
+     * in the Gradle User Guide for detailed information about Gradle's interpretation of version numbers.
      *
      * @param version Version to parse
      * @return Version object corresponding to the specified version string.

src/main/java/org/cthing/versionparser/maven/MvnVersionScheme.java

@@ -47,7 +47,11 @@ private MvnVersionScheme() {
     }
 
     /**
-     * Parses a Maven artifact version.
+     * Parses a Maven artifact version. A Maven version consists of almost any combination of digits, letters, periods
+     * and dashes (e.g. 1, 1.0.0, a, 1.0b, 1.0-alpha). Semantic Versions are valid Maven versions, but the converse
+     * is not true. Refer to the {@link MvnVersion} class and the
+     * <a href="https://maven.apache.org/pom.html#Version_Order_Specification">Maven Version Ordering Specification</a>
+     * for a detailed explanation of Maven version numbers and their relationships.
      *
      * @param version Version to parse
      * @return Version object corresponding to the specified version string.