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

Timestamp:

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

Author:

bensch

Message:

orxonox/trunk: doxygen-tags

File:

• trunk/src/lib/shell/shell_command.cc (modified) (5 diffs)

trunk/src/lib/shell/shell_command.cc

@@ -61 +61 @@
 }
 
+/**
+ * collects the Commands registered to some class.
+ * @param className the name of the Class to collect the Commands from.
+ * @param stringList a List to paste the Commands into.
+ * @returns true on success, false otherwise
+ */
 bool ShellCommandClass::getCommandListOfClass(const char* className, tList<const char>* stringList)
 {
@@ -88 +94 @@
 }
 
+/**
+ * collects the Aliases registered to the ShellCommands
+ * @param stringList a List to paste the Aliases into.
+ * @returns true on success, false otherwise
+ */
 bool ShellCommandClass::getCommandListOfAlias(tList<const char>* stringList)
 {
@@ -104 +115 @@
 }
 
-
 /**
  * unregisters all Commands that exist
@@ -127 +137 @@
   if (ShellCommandClass::aliasList != NULL)
   {
-   tIterator<ShellCommandAlias>* itAL = ShellCommandClass::aliasList->getIterator();
-   ShellCommandAlias* elemAL = itAL->firstElement();
-   while(elemAL != NULL)
-   {
-     delete elemAL;
-     elemAL = itAL->nextElement();
-   }
-   delete itAL;
-   delete ShellCommandClass::aliasList;
-   ShellCommandClass::aliasList = NULL;
-  }
-}
-
+    tIterator<ShellCommandAlias>* itAL = ShellCommandClass::aliasList->getIterator();
+    ShellCommandAlias* elemAL = itAL->firstElement();
+    while(elemAL != NULL)
+    {
+      delete elemAL;
+      elemAL = itAL->nextElement();
+    }
+    delete itAL;
+    delete ShellCommandClass::aliasList;
+    ShellCommandClass::aliasList = NULL;
+  }
+}
+
+/**
+ * checks if a Class is already registered to the Commands' class-stack
+ * @param className the Name of the Class to check for
+ * @returns the CommandClass if found, NULL otherwise
+ */
 const ShellCommandClass* ShellCommandClass::isRegistered(const char* className)
 {
@@ -468 +483 @@
 }
 
+/**
+ * adds an Alias to this Command
+ * @param alias the name of the Alias to set
+ * @returns itself
+ */
 ShellCommandBase* ShellCommandBase::setAlias(const char* alias)
 {