diff --git a/rapier-example/rapier-example-cli/src/main/java/rapier/example/cli/App.java b/rapier-example/rapier-example-cli/src/main/java/rapier/example/cli/App.java index fd1a6c3..d5389a4 100644 --- a/rapier-example/rapier-example-cli/src/main/java/rapier/example/cli/App.java +++ b/rapier-example/rapier-example-cli/src/main/java/rapier/example/cli/App.java @@ -20,8 +20,8 @@ package rapier.example.cli; /** - * The main entry point for the server application. This class creates the Dagger component and - * starts the server. + * The main entry point for the CLI application. This class creates the Dagger component prints + * the greeting. */ public class App { public static void main(String[] args) { diff --git a/rapier-example/rapier-example-cli/src/main/java/rapier/example/cli/Greeter.java b/rapier-example/rapier-example-cli/src/main/java/rapier/example/cli/Greeter.java index 0caae2a..85cf67b 100644 --- a/rapier-example/rapier-example-cli/src/main/java/rapier/example/cli/Greeter.java +++ b/rapier-example/rapier-example-cli/src/main/java/rapier/example/cli/Greeter.java @@ -19,6 +19,9 @@ */ package rapier.example.cli; +/** + * Greeter is a simple class that generates a greeting. + */ public class Greeter { private final String greeting; private final String name; diff --git a/rapier-example/rapier-example-cli/src/main/java/rapier/example/cli/GreeterComponent.java b/rapier-example/rapier-example-cli/src/main/java/rapier/example/cli/GreeterComponent.java index 631deb2..608fbf6 100644 --- a/rapier-example/rapier-example-cli/src/main/java/rapier/example/cli/GreeterComponent.java +++ b/rapier-example/rapier-example-cli/src/main/java/rapier/example/cli/GreeterComponent.java @@ -21,6 +21,12 @@ import dagger.Component; +/** + * A Dagger component that provides a {@link Greeter} instance. Note that it includes both + * {@link GreeterModule} and {@link RapierGreeterComponentCliModule} modules, where + * {@link RapierGreeterComponentCliModule} is a generated module that provides the CLI parameters + * for the {@link Greeter} instance. + */ @Component(modules = {GreeterModule.class, RapierGreeterComponentCliModule.class}) public interface GreeterComponent { public Greeter greeter(); diff --git a/rapier-example/rapier-example-cli/src/main/java/rapier/example/cli/GreeterModule.java b/rapier-example/rapier-example-cli/src/main/java/rapier/example/cli/GreeterModule.java index a3d7766..23b5ec3 100644 --- a/rapier-example/rapier-example-cli/src/main/java/rapier/example/cli/GreeterModule.java +++ b/rapier-example/rapier-example-cli/src/main/java/rapier/example/cli/GreeterModule.java @@ -25,6 +25,9 @@ import rapier.cli.CliOptionParameterHelp; import rapier.cli.CliPositionalParameter; +/** + * A Dagger module that provides a {@link Greeter} object from CLI input. + */ @Module public class GreeterModule { @Provides