Skip to content

[SHRINKRES-501] Improve JavaDocs of methods taking coordinate in canonical form #577

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AnkitKumar-05 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[SHRINKRES-501] Improve JavaDocs of methods taking coordinate in canonical form #577

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions api/src/main/java/org/jboss/shrinkwrap/resolver/api/ResolveStage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
Loading