Changes between Version 4 and Version 5 of code/doc/CommandExecutor

Timestamp:

Oct 7, 2008, 6:28:47 PM (16 years ago)

Author:

landauf

Comment:

—

code/doc/CommandExecutor

@@ -110 +110 @@
 
 === complete() ===
-'''complete('''''string''''')'''
+'''complete('''''string''''')''' looks at the list of possible classnames, functionnames and arguments (like hint() in example 2) and trys to complete the command if there's only one possibility.
+
+Note: If there's only one possible class with only one function and only one possible argument, complete() returns the whole command.
+
+ * Example 2:
+{{{
+// Existing functions:
+// abc, function1, function2, test, temporary
+
+CommandExecutor::complete("a");
+// returns "abc" because it's the only possibility
+
+CommandExecutor::complete("fun");
+// returns "function" because function1 and function2 are possible and
+// "function" is the common begin of both
+
+CommandExecutor::complete("t");
+// returns "te" because it's the common begin of "test" and "temporary"
+}}}
+
+ * Example 2:
+{{{
+// Existing classes:
+// MyClass
+
+// Existing functions in MyClass:
+// myfunction
+
+// Possible arguments of MyClass::myfunction:
+// 10
+
+CommandExecutor::complete("m");
+// returns "MyClass myfunction 10"
+}}}
 
 === evaluate() ===