changeset 7347:0fa079d04772

[project @ 2008-01-04 21:09:11 by jwe]
author jwe
date Fri, 04 Jan 2008 21:09:12 +0000
parents 40252ccfcb67
children d1a97ad87264
files src/ChangeLog src/variables.cc
diffstat 2 files changed, 23 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog	Fri Jan 04 20:26:26 2008 +0000
+++ b/src/ChangeLog	Fri Jan 04 21:09:12 2008 +0000
@@ -1,3 +1,7 @@
+2008-01-04  Thomas Weber  <thomas.weber.mail@gmail.com>
+
+	* variables.cc (Fclear): Doc fix.
+
 2008-01-04  John W. Eaton  <jwe@octave.org>
 
 	* symtab.h (symbol_table:pop_scope): Avoid accessing beyond end of
--- a/src/variables.cc	Fri Jan 04 20:26:26 2008 +0000
+++ b/src/variables.cc	Fri Jan 04 21:09:12 2008 +0000
@@ -2230,7 +2230,7 @@
 
 DEFCMD (clear, args, ,
   "-*- texinfo -*-\n\
-@deffn {Command} clear [-x] pattern @dots{}\n\
+@deffn {Command} clear [options] pattern @dots{}\n\
 Delete the names matching the given patterns from the symbol table.  The\n\
 pattern may contain the following special characters:\n\
 \n\
@@ -2268,7 +2268,24 @@
 @code{foo} as a function.  Executing @kbd{clear foo} a second time will\n\
 clear the function definition.\n\
 \n\
-With -x, clear the variables that don't match the patterns.\n\
+The following options are available in both long and short form\n\
+@table @code\n\
+@item -all, -a\n\
+Clears all local and global user-defined variables and all functions\n\
+from the symbol table.\n\
+\n\
+@item -exclusive, -x\n\
+Clears the variables that don't match the following pattern.\n\
+\n\
+@item -functions, -f\n\
+Clears the function names and the built-in symbols names.\n\
+@item -global, -g\n\
+Clears the global symbol names.\n\
+@item -variables, -v\n\
+Clears the local variable names.\n\
+@end table\n\
+With the execption of @code{exclusive}, all long options can be used \n\
+without the dash as well.\n\
 @end deffn")
 {
   octave_value_list retval;