Add javadoc to OciCopySpec.with(OciCopySpec)

SgtSilvio · May 26, 2024 · 5032691 · 5032691
1 parent f32583c
commit 5032691
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/main/kotlin/io/github/sgtsilvio/gradle/oci/OciCopySpec.kt b/src/main/kotlin/io/github/sgtsilvio/gradle/oci/OciCopySpec.kt
@@ -201,5 +201,14 @@ interface OciCopySpec {
      */
     fun groupId(pathPattern: String, groupId: Long): OciCopySpec
 
+    /**
+     * Adds the given copy spec as a child to the current copy spec.
+     * This allows reusing copy specs in multiple places.
+     *
+     * @param other the copy spec to add as a child to the current copy spec
+     * @return the current copy spec
+     * @throws IllegalArgumentException if adding the given copy spec as a child to the current copy spec would result in a cycle
+     * (the current copy spec is the same as or a transitive child of the given copy spec)
+     */
     fun with(other: OciCopySpec): OciCopySpec
 }