[MNG-7344] Add since and docs to methods

infosupport · Apr 12, 2024 · 73f5ff2 · 73f5ff2
1 parent 237de75
commit 73f5ff2
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 1 deletion.
diff --git a/api/maven-api-model/src/main/java/org/apache/maven/api/model/InputLocation.java b/api/maven-api-model/src/main/java/org/apache/maven/api/model/InputLocation.java
@@ -98,6 +98,8 @@ public Map<Object, InputLocation> getLocations() {
     /**
      * Gets the parent InputLocation where this InputLocation may have been imported from.
      * Can return {@code null}.
+     *
+     * @return InputLocation
      * @since 4.0.0
      */
     public InputLocation getImportedFrom() {

diff --git a/api/maven-api-model/src/main/java/org/apache/maven/api/model/InputLocationTracker.java b/api/maven-api-model/src/main/java/org/apache/maven/api/model/InputLocationTracker.java
@@ -21,5 +21,12 @@
 public interface InputLocationTracker {
     InputLocation getLocation(Object field);
 
+    /**
+     * Gets the parent InputLocation where this InputLocation may have been imported from.
+     * Can return {@code null}.
+     *
+     * @return InputLocation
+     * @since 4.0.0
+     */
     InputLocation getImportedFrom();
 }
diff --git a/api/maven-api-model/src/main/java/org/apache/maven/api/model/InputSource.java b/api/maven-api-model/src/main/java/org/apache/maven/api/model/InputSource.java
@@ -71,6 +71,13 @@ public String getModelId() {
         return this.modelId;
     }
 
+    /**
+     * Gets the parent InputLocation where this InputLocation may have been imported from.
+     * Can return {@code null}.
+     *
+     * @return InputLocation
+     * @since 4.0.0
+     */
     public InputLocation getImportedFrom() {
         return importedFrom;
     }

diff --git a/maven-model/src/main/java/org/apache/maven/model/InputLocation.java b/maven-model/src/main/java/org/apache/maven/model/InputLocation.java
@@ -224,9 +224,11 @@ public InputSource getSource() {
     } // -- InputSource getSource()
 
     /**
-     * Get the imported from location.
+     * Gets the parent InputLocation where this InputLocation may have been imported from.
+     * Can return {@code null}.
      *
      * @return InputLocation
+     * @since 4.0.0
      */
     public InputLocation getImportedFrom() {
         return importedFrom;