Changeset 5197 in orxonox.OLD for trunk/src/lib

Timestamp:

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

Author:

bensch

Message:

orxonox/trunk: doxygen-tags

Location:

trunk/src/lib/shell

Files:

• shell.h (modified) (2 diffs)
• shell_command.cc (modified) (5 diffs)
• shell_command.h (modified) (2 diffs)
• shell_completion.cc (modified) (3 diffs)
• shell_completion.h (modified) (4 diffs)
• shell_input.cc (modified) (1 diff)

trunk/src/lib/shell/shell.h

@@ -42 +42 @@
     void activate();
     void deactivate();
+    /** @returns true if the Shell is active, false otherwise. */
     inline bool isActive() const { return this->bActive; };
 
@@ -82 +83 @@
 
     // HANDLING TEXT INPUT
-    ShellInput*              shellInput;
+    ShellInput*              shellInput;             //!< The inputLine of the Shell.
     // BUFFER
     unsigned int             bufferDisplaySize;      //!< The Size of the Display-buffer, in lines (not in characters)

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)
 {

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 */

trunk/src/lib/shell/shell_completion.cc

@@ -202 +202 @@
  * completes a Function
  * @param functionBegin the beginning of the function String
+ * @param classID the class' ID to complete the function of
  */
 bool ShellCompletion::functionComplete(const char* functionBegin, long classID)
@@ -215 +216 @@
 }
 
+/**
+ * completes an Alias
+ * @param aliasBegin the beginning of the Alias-String to complete
+ * @returns true on succes, false if something went wrong
+ */
 bool ShellCompletion::aliasComplete(const char* aliasBegin)
 {
@@ -352 +358 @@
 }
 
-
+/**
+ * deletes the Completion List.
+ *
+ * This is done at the beginning of each completion-run
+ */
 void ShellCompletion::emptyCompletionList()
 {

trunk/src/lib/shell/shell_completion.h

@@ -15 +15 @@
 #endif
 
+//! an enumerator for different types the Shell can complete.
 typedef enum {
   SHELLC_NONE        = 0,
@@ -23 +24 @@
 } SHELLC_TYPE;
 
+//! A struct for ShellElements (these are used as containers to identify an Input for what it is)
 struct ShellC_Element{
-  const char*     name;     //!<
-  SHELLC_TYPE     type;
+  const char*     name;     //!< the Name of the Element to be completed.
+  SHELLC_TYPE     type;     //!< the type of the Element
 };
 
@@ -37 +39 @@
   bool autoComplete(ShellInput* input = NULL);
   bool classComplete(const char* classBegin);
-  long classMatch(const char* input, unsigned int* length);
+//  long classMatch(const char* input, unsigned int* length);
   bool objectComplete(const char* objectBegin, long classID);
-  bool objectMatch(const char* objectBegin, long classID, unsigned int* length);
+//  bool objectMatch(const char* objectBegin, long classID, unsigned int* length);
   bool functionComplete(const char* functionBegin, long classID);
-  bool functionMatch(const char* functionBegin, long classID, unsigned int* length);
+//  bool functionMatch(const char* functionBegin, long classID, unsigned int* length);
   bool aliasComplete(const char* aliasBegin);
 
@@ -52 +54 @@
  private:
    tList<ShellC_Element>*   completionList;          //!< A list of completions, that are io.
-   ShellInput*              input;
+   ShellInput*              input;                   //!< the input this completion works on.
 };
 

trunk/src/lib/shell/shell_input.cc

@@ -182 +182 @@
 }
 
+/**
+ * ticks the ShellInput
+ * @param dt the time passed since the last update
+ */
 void ShellInput::tick(float dt)
 {