Ver Fonte

AmberCli: add class comment

Manfred Kroehnert há 11 anos atrás
pai
commit
bfd782f2a2
2 ficheiros alterados com 13 adições e 0 exclusões
  1. 1 0
      cli/js/AmberCli.js
  2. 12 0
      cli/st/AmberCli.st

+ 1 - 0
cli/js/AmberCli.js

@@ -1,5 +1,6 @@
 smalltalk.addPackage('AmberCli');
 smalltalk.addClass('AmberCli', smalltalk.Object, [], 'AmberCli');
+smalltalk.AmberCli.comment="I am the Amber CLI (CommandLine Interface) tool which runs on Node.js.\x0a\x0aMy responsibility is to start different Amber programs like the FileServer or the Repl.\x0aWhich program to start is determined by the first commandline parameters passed to the AmberCli executable.\x0aUse `help` to get a list of all available options.\x0aAny further commandline parameters are passed to the specific program.\x0a\x0a## Commands\x0a\x0aNew commands can be added by creating a unary class side method in the `commands` protocol.\x0aAny `camelCaseCommand` is transformed into a commandline parameter of the form `camel-case-command` and vice versa."
 
 smalltalk.addMethod(
 smalltalk.method({

+ 12 - 0
cli/st/AmberCli.st

@@ -2,6 +2,18 @@ Smalltalk current createPackage: 'AmberCli'!
 Object subclass: #AmberCli
 	instanceVariableNames: ''
 	package: 'AmberCli'!
+!AmberCli commentStamp!
+I am the Amber CLI (CommandLine Interface) tool which runs on Node.js.
+
+My responsibility is to start different Amber programs like the FileServer or the Repl.
+Which program to start is determined by the first commandline parameters passed to the AmberCli executable.
+Use `help` to get a list of all available options.
+Any further commandline parameters are passed to the specific program.
+
+## Commands
+
+New commands can be added by creating a unary class side method in the `commands` protocol.
+Any `camelCaseCommand` is transformed into a commandline parameter of the form `camel-case-command` and vice versa.!
 
 !AmberCli class methodsFor: 'commandline'!