Changeset 5197 in orxonox.OLD for trunk/src/lib/shell/shell_completion.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_completion.cc (modified) (3 diffs)

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