From 8016d5139f6a1c0e587dd49980c06dce6ea1a899 Mon Sep 17 00:00:00 2001
From: AnkitKumar-05 <2887ankit@gmail.com>
Date: Mon, 19 Oct 2026 13:37:51 +0100
Subject: [PATCH] [SHRINKRES-501] Improve JavaDocs of methods taking coordinate
 in canonical form

---
 .../jboss/shrinkwrap/resolver/api/ResolveStage.java  | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/api/src/main/java/org/jboss/shrinkwrap/resolver/api/ResolveStage.java b/api/src/main/java/org/jboss/shrinkwrap/resolver/api/ResolveStage.java
index c43bc3315..dbd175f0d 100644
--- a/api/src/main/java/org/jboss/shrinkwrap/resolver/api/ResolveStage.java
+++ b/api/src/main/java/org/jboss/shrinkwrap/resolver/api/ResolveStage.java
@@ -44,7 +44,9 @@ public interface ResolveStage<COORDINATETYPE extends Coordinate, RESOLUTIONFILTE
      * for the user to define the {@link ResolutionStrategy}. Previously-added dependencies will
      * be included in resolution.
      *
-     * @param canonicalForm The canonical form of the single desired dependency.
+     * @param canonicalForm The single desired dependency in canonical form
+     *    {@code <groupId>:<artifactId>[:<packagingType>[:<classifier>]]:(<version>|'?')}.
+     *    The version may be specified as {@code '?'} to infer it from a loaded POM.
      * @return The next {@link StrategyStage} for the user to define the {@link ResolutionStrategy}.
      * @throws IllegalArgumentException
      * If no coordinate is supplied
@@ -61,7 +63,9 @@ STRATEGYSTAGETYPE resolve(String canonicalForm) throws IllegalArgumentException,
      * for the user to define the {@link ResolutionStrategy}. Previously-added dependencies will
      * be included in resolution.
      *
-     * @param canonicalForms The canonical forms of the set of desired dependencies.
+     * @param canonicalForms The set of desired dependencies, each in canonical form
+     *    {@code <groupId>:<artifactId>[:<packagingType>[:<classifier>]]:(<version>|'?')}.
+     *    The version may be specified as {@code '?'} to infer it from a loaded POM.
      * @return The next {@link StrategyStage} for the user to define the {@link ResolutionStrategy}.
      * @throws IllegalArgumentException
      * If no coordinates are supplied
@@ -78,7 +82,9 @@ STRATEGYSTAGETYPE resolve(String... canonicalForms) throws IllegalArgumentExcept
      * next {@link StrategyStage} for the user to define the {@link ResolutionStrategy}. Previously-added dependencies
      * will be included in resolution.
      *
-     * @param canonicalForms  A {@link Collection} of the canonical forms of the desired dependencies.
+     * @param canonicalForms  A {@link Collection} of desired dependencies, each in canonical form
+     *    {@code <groupId>:<artifactId>[:<packagingType>[:<classifier>]]:(<version>|'?')}.
+     *    The version may be specified as {@code '?'} to infer it from a loaded POM.
      * @return The next {@link StrategyStage} for the user to define the {@link ResolutionStrategy}.
      * @throws IllegalArgumentException
      * If no coordinates are supplied