Update TerminalApp doc

xtclang · Nov 19, 2024 · 564aa24 · 564aa24
1 parent 13721b6
commit 564aa24
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/lib_cli/src/main/x/cli.x b/lib_cli/src/main/x/cli.x
@@ -3,10 +3,18 @@
  *
  * To use the CLI library, the application code needs to do the following:
  *     - annotate the module as a `TerminalApp`, for example:
+ *
  *          @TerminalApp("My commands")
- *          module MyCommands {...}
+ *          module MyCommands {
+ *              package cli import cli.xtclang.org;
+ *
+ *              import cli.*;
+ *
+ *              ...
+ *          }
  *
  *     - annotate any methods to be executed as a command with the `Command` annotation, for example:
+ *
  *          @Command("time", "Show current time")
  *          Time showTime() {
  *             @Inject Clock clock;