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

Timestamp:

Sep 18, 2005, 2:57:20 AM (20 years ago)

Author:

bensch

Message:

orxonox/trunk: doxygen-tags

File:

• trunk/src/lib/shell/shell_command.h (modified) (2 diffs)

trunk/src/lib/shell/shell_command.h

@@ -51 +51 @@
 
   public:
+    /** @returns the CommandClassList */
     static const tList<ShellCommandClass>* getCommandClassList() { return ShellCommandClass::commandClassList; };
     static bool getCommandListOfClass(const char* className, tList<const char>* stringList);
@@ -317 +318 @@
 };
 
+//! A Class, that handles aliases.
 class ShellCommandAlias
 {
   friend class ShellCommandBase;
   public:
+    /** @returns the Name of the Alias. */
     const char* getName() const { return this->aliasName; };
+    /** @returns the Command, this Alias is asociated with */
     ShellCommandBase* getCommand() const { return this->command; };
 
   private:
+    /** @param aliasName the name of the Alias @param command the Command, to associate this alias with */
     ShellCommandAlias(const char* aliasName, ShellCommandBase* command) { this->aliasName = aliasName; this->command = command; };
 
   private:
-    const char*         aliasName;
-    ShellCommandBase*   command;
+    const char*         aliasName;       //!< the name of the Alias
+    ShellCommandBase*   command;         //!< a pointer to the command, this alias executes.
 };
 
-
 #endif /* _SHELL_COMMAND_H */