diff --git a/docs/src/reference/docbook/reference/shell.xml b/docs/src/reference/docbook/reference/shell.xml index 391967f7..83d9796b 100644 --- a/docs/src/reference/docbook/reference/shell.xml +++ b/docs/src/reference/docbook/reference/shell.xml @@ -113,7 +113,17 @@ public class HelloWorldCommands implements CommandMarker { - EssentialCommands - + ConsoleCommands - + clr and clear - to clear the console. + + + + DateCommands - + date - show the current date and time. + + + + ExitCommands - exit and quit - to exit the shell. @@ -123,36 +133,36 @@ public class HelloWorldCommands implements CommandMarker { list all commands and their usage + + InlineCommentCommands - // and ; shows the valid characters to use for inline comments + + OsCommands - the keyword for this command is the exclamation point, !. After the exclamation point you can pass in a unix/windows command string to be executed. + + + SystemPropertyCommands - system properties- shows the shell's system properties + + There are also a few commands that are provided by the AbstractShell class, these are - - date - Displays the local date and - time - - script - Parses the specified resource file and executes its commands - system properties - Shows the shell's - properties + /* and */- The begin and end characters for block comments - - version - Displays current CLI version - diff --git a/src/main/java/org/springframework/shell/commands/InlineCommentCommands.java b/src/main/java/org/springframework/shell/commands/InlineCommentCommands.java index 2d4d5f12..ca870626 100644 --- a/src/main/java/org/springframework/shell/commands/InlineCommentCommands.java +++ b/src/main/java/org/springframework/shell/commands/InlineCommentCommands.java @@ -19,6 +19,10 @@ import org.springframework.shell.core.CommandMarker; import org.springframework.shell.core.annotation.CliCommand; import org.springframework.stereotype.Component; +/** + * Commands relating to inline comments + * + */ @Component public class InlineCommentCommands implements CommandMarker {