Skip to content

Commit 58aa1b1

Browse files
committed
Sprinkle some javadoc
1 parent 5f6f85f commit 58aa1b1

File tree

15 files changed

+17
-14
lines changed

15 files changed

+17
-14
lines changed

cli/src/main/java/eu/maveniverse/maven/mima/cli/ArtifactRecorder.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313
import org.eclipse.aether.artifact.Artifact;
1414
import org.eclipse.aether.repository.RemoteRepository;
1515

16+
/**
17+
* Records in-memory all the resolved artifacts.
18+
*/
1619
final class ArtifactRecorder extends AbstractRepositoryListener {
1720
private final RemoteRepository sentinel = new RemoteRepository.Builder("none", "default", "fake").build();
1821
private final ConcurrentHashMap<RemoteRepository, ArrayList<Artifact>> artifactsMap = new ConcurrentHashMap<>();

cli/src/main/java/eu/maveniverse/maven/mima/cli/Classpath.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
import picocli.CommandLine;
1515

1616
/**
17-
* Classpath.
17+
* Resolves transitively a given GAV and outputs classpath path.
1818
*/
1919
@CommandLine.Command(name = "classpath", description = "Resolves Maven Artifact and prints out the classpath")
2020
public final class Classpath extends ResolverCommandSupport {

cli/src/main/java/eu/maveniverse/maven/mima/cli/CommandSupport.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import picocli.CommandLine;
2727

2828
/**
29-
* Support.
29+
* Support class.
3030
*/
3131
public abstract class CommandSupport implements Callable<Integer> {
3232
@CommandLine.Option(

cli/src/main/java/eu/maveniverse/maven/mima/cli/Deploy.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
import picocli.CommandLine;
1212

1313
/**
14-
* Deploy.
14+
* Deploys an artifact into remote repository.
1515
*/
1616
@CommandLine.Command(name = "deploy", description = "Deploys Maven Artifacts")
1717
public final class Deploy extends ResolverCommandSupport {

cli/src/main/java/eu/maveniverse/maven/mima/cli/DeployRecorded.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
import picocli.CommandLine;
1010

1111
/**
12-
* Deploy recorded.
12+
* Deploys recorded artifacts to remote repository.
1313
*/
1414
@CommandLine.Command(name = "deployRecorded", description = "Deploys recorded Maven Artifacts")
1515
public final class DeployRecorded extends ResolverCommandSupport {

cli/src/main/java/eu/maveniverse/maven/mima/cli/Dump.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import picocli.CommandLine;
44

55
/**
6-
* Dump.
6+
* Dumps MIMA environment.
77
*/
88
@CommandLine.Command(name = "dump", description = "Dump MIMA environment")
99
public final class Dump extends CommandSupport {

cli/src/main/java/eu/maveniverse/maven/mima/cli/Exists.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
import picocli.CommandLine;
1414

1515
/**
16-
* Exists.
16+
* Checks given GAV for existence in a remote repository.
1717
*/
1818
@CommandLine.Command(name = "exists", description = "Checks Maven Artifact existence")
1919
public final class Exists extends SearchCommandSupport {

cli/src/main/java/eu/maveniverse/maven/mima/cli/Graph.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
import picocli.CommandLine;
3131

3232
/**
33-
* Graph.
33+
* Collects given GAV and output its dependency graph.
3434
*/
3535
@CommandLine.Command(name = "graph", description = "Displays dependency graph")
3636
public final class Graph extends ResolverCommandSupport {

cli/src/main/java/eu/maveniverse/maven/mima/cli/Identify.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import picocli.CommandLine;
1717

1818
/**
19-
* Identify.
19+
* Identify artifact, either by provided SHA-1 or calculated SHA-1 of a file pointed at.
2020
*/
2121
@CommandLine.Command(name = "identify", description = "Identifies Maven Artifacts")
2222
public final class Identify extends SearchCommandSupport {

cli/src/main/java/eu/maveniverse/maven/mima/cli/Install.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
import picocli.CommandLine;
1111

1212
/**
13-
* Install.
13+
* Installs an artifact into local repository.
1414
*/
1515
@CommandLine.Command(name = "install", description = "Installs Maven Artifacts")
1616
public final class Install extends ResolverCommandSupport {

0 commit comments

Comments
 (0)