Skip to content

Commit

Permalink
tweak javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
sigpwned committed Jan 16, 2025
1 parent e26221b commit a0639eb
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a0639eb

Please sign in to comment.