changeset 3447:5c76d8f267f7

[project @ 2000-01-17 20:12:43 by jwe]
author jwe
date Mon, 17 Jan 2000 20:12:43 +0000
parents 5ee5afb3981a
children 0fb75d95b14f
files src/ChangeLog src/oct-procbuf.cc src/ov-list.cc
diffstat 3 files changed, 48 insertions(+), 33 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog	Mon Jan 17 09:42:48 2000 +0000
+++ b/src/ChangeLog	Mon Jan 17 20:12:43 2000 +0000
@@ -9,6 +9,7 @@
 	* toplev.cc (Fwarranty, Fcasesen): Ditto.
 	* utils.cc (Fdo_string_escapes, Ffile_in_loadpath): Ditto.
 	* variables.cc (F__dump_symtab_info__, F__dump_symbol_info__): Ditto.
+	* ov-list.cc (Flist, Fappend, Fnth, Freverse, Fsplice): Ditto.
 
 	* pt-plot.cc (Fgraw, Fgset, Fgshow, Vgnuplot_command_plot, 
 	Vgnuplot_command_replot, Vgnuplot_command_splot,
@@ -16,6 +17,9 @@
 	Vgnuplot_command_axes, Vgnuplot_command_title,
 	Vgnuplot_command_end): Texinfoize doc strings.
 
+	* oct-procbuf.cc (__kluge_procbuf_delay__): Rename from
+	kluge_procbuf_delay.  Texinfoize doc string.
+
 2000-01-13  John W. Eaton  <jwe@bevo.che.wisc.edu>
 
 	* parse.y (gobble_leading_whitespace): Discard first space character
--- a/src/oct-procbuf.cc	Mon Jan 17 09:42:48 2000 +0000
+++ b/src/oct-procbuf.cc	Mon Jan 17 20:12:43 2000 +0000
@@ -184,7 +184,7 @@
 kluge_procbuf_delay (void)
 {
   double val;
-  if (builtin_real_scalar_variable ("kluge_procbuf_delay", val)
+  if (builtin_real_scalar_variable ("__kluge_procbuf_delay__", val)
       && ! xisnan (val))
     {
       int ival = NINT (val);
@@ -194,16 +194,20 @@
 	  return 0;
 	}
     }
-  gripe_invalid_value_specified ("kluge_procbuf_delay");
+  gripe_invalid_value_specified ("__kluge_procbuf_delay__");
   return -1;
 }
 
 void
 symbols_of_oct_procbuf (void)
 {
-  DEFVAR (kluge_procbuf_delay, static_cast<double> (Vkluge_procbuf_delay),
+  DEFVAR (__kluge_procbuf_delay__, static_cast<double> (Vkluge_procbuf_delay),
 	  kluge_procbuf_delay,
-    "number of microseconds to delay in the parent after forking");
+    "-*- texinfo -*-\n\
+@defvr __kluge_procbuf_delay__\n\
+Number of microseconds to delay in the parent after forking.\n\
+@end defvr");
+
 }
 
 /*
--- a/src/ov-list.cc	Mon Jan 17 09:42:48 2000 +0000
+++ b/src/ov-list.cc	Mon Jan 17 20:12:43 2000 +0000
@@ -144,17 +144,20 @@
 }
 
 DEFUN (list, args, ,
-  "list (ARGS)\n\
-\n\
-Create a new list from ARGS.")
+  "-*- texinfo -*-\n\
+@deftypefn {Built-in Function} {} list (@var{a1}, @var{a2}, @dots{}})\n\
+Create a new list with elements given by the arguments @var{a1},\n\
+@var{a2}, @dots{}.\n\
+@end deftypefn")
 {
   return octave_value (args);
 }
 
 DEFUN (nth, args, ,
-  "nth (LIST, N)\n\
-\n\
-Return the N-th element of LIST.")
+  "-*- texinfo -*-\n\
+@deftypefn {Built-in Function} {} nth (@var{list}, @var{n})\n\
+Return the @var{n}-th element of @var{list}.\n\
+@end deftypefn")
 {
   octave_value retval;
 
@@ -186,18 +189,22 @@
 }
 
 DEFUN (append, args, ,
-  "append (LIST, ARG, ...)\n\
-\n\
-Return a new list created by appending each ARG to LIST.  If any of\n\
-the arguments to be appended is a list, its elements are appended\n\
-individually.  For example,\n\
+  "-*- texinfo -*-\n\
+@deftypefn {Built-in Function} {} append (@var{list}, @var{a1}, @var{a2}, @dots{})\n\
+Return a new list created by appending @var{a1}, @var{a1}, @dots{}, to\n\
+@var{list}.  If any of the arguments to be appended is a list, its\n\
+elements are appended individually.  For example,\n\
 \n\
-  x = list (1, 2);\n\
-  y = list (3, 4);\n\
-  append (x, y);\n\
+@example\n\
+x = list (1, 2);\n\
+y = list (3, 4);\n\
+append (x, y);\n\
+@end example\n\
 \n\
-results in the list containing the four elements (1 2 3 4), not a list\n\
-containing the three elements (1 2 (3 4))")
+@noindent\n\
+results in the list containing the four elements @samp{(1 2 3 4)}, not\n\
+a list containing the three elements @samp{(1 2 (3 4))}.\n\
+@end deftypefn")
 {
   octave_value retval;
 
@@ -229,9 +236,10 @@
 }
 
 DEFUN (reverse, args, ,
-  "reverse (LIST)\n\
-\n\
-Return a new list created by reversing the elements of LIST")
+  "-*- texinfo -*-\n\
+@deftypefn {Built-in Function} {} reverse (@var{list})\n\
+Return a new list created by reversing the elements of @var{list}.\n\
+@end deftypefn")
 {
   octave_value retval;
 
@@ -251,16 +259,15 @@
 }
 
 DEFUN (splice, args, ,
-  "splice (LIST_1, OFFSET, LENGTH, LIST_2)\n\
-splice (LIST_1, OFFSET, LENGTH, LIST_2)\n\
-splice (LIST_1, OFFSET, LENGTH)\n\
-splice (LIST_1, OFFSET)\n\
-\n\
-Replace LENGTH elements of LIST_1 beginning at OFFSET with the\n\
-contents of LIST_2 (if any).  If LENGTH is omitted, all elements\n\
-from OFFSET to the end of LIST_1 are replaced.  As a special case, if\n\
-OFFSET is one greater than the length of LIST_1 and LENGTH is 0,\n\
-splice is equivalent to append (LIST_1, LIST_2)")
+  "-*- texinfo -*-\n\
+@deftypefn {Built-in Function} {} splice (@var{list_1}, @var{offset}, @var{length}, @var{list_2})\n\
+Replace @var{length} elements of @var{list_1} beginning at\n\
+@var{offset} with the contents of @var{list_2} (if any).  If\n\
+@var{length} is omitted, all elements from @var{offset} to the end of\n\
+@var{list_1} are replaced.  As a special case, if @var{offset} is one\n\
+greater than the length of @var{list_1} and @var{length} is 0, splice\n\
+is equivalent to @code{append (@var{list_1}, @var{list_2}).\n\
+@end deftypefn") 
 {
   octave_value retval;