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

Timestamp:

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

Author:

bensch

Message:

orxonox/trunk: doxygen-tags

File:

• trunk/src/lib/shell/shell_completion.h (modified) (4 diffs)

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.
 };