Changeset 5179 in orxonox.OLD for trunk/src/lib/shell/shell_command.h

Timestamp:

Sep 13, 2005, 11:23:34 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: ShellInput is now almost perfectly extern.
ShellCompletion taken out.
Working again

File:

• trunk/src/lib/shell/shell_command.h (modified) (1 diff)

trunk/src/lib/shell/shell_command.h

@@ -27 +27 @@
  * @param class the name of the class to apply this command to (without the "" around the string)
  * @param function the function to call
+ *
+ * MEANING:
+ *  ShellCommandBase* someUniqueVarName =
+ *       ShellCommand<ClassName>::registerCommand("commandNameInShell", "ClassName", &ClassName::FunctionToCall);
+ *
+ * In the Shell you would call this Command using:
+ * $ ClassName [ObjectName] commandNameInShell [parameters]
  */
 #define SHELL_COMMAND(command, class, function) \