changeset 3445:c3eed8ac845a

[project @ 2000-01-17 09:06:51 by jwe]
author jwe
date Mon, 17 Jan 2000 09:06:52 +0000
parents fa0d84558faa
children 5ee5afb3981a
files src/ChangeLog src/ov-typeinfo.cc src/ov-usr-fcn.cc
diffstat 3 files changed, 31 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,8 +1,10 @@
 2000-01-17  John W. Eaton  <jwe@bevo.che.wisc.edu>
 
 	* DLD-FUNCTIONS/gammainc.cc (Fgammainc): Texinfoize doc string.
+	* ov-typeinfo.cc (Ftypeinfo): Ditto.
 
 	* DLD-FUNCTIONS/minmax.cc (Fmax, Fmin): Texinfoize doc strings.
+	* ov-usr-fcn.cc (Fva_arg, Fva_start, Fvr_val): Ditto.
 
 	* pt-plot.cc (Fgraw, Fgset, Fgshow, Vgnuplot_command_plot, 
 	Vgnuplot_command_replot, Vgnuplot_command_splot,
--- a/src/ov-typeinfo.cc
+++ b/src/ov-typeinfo.cc
@@ -314,11 +314,13 @@
 }
 
 DEFUN (typeinfo, args, ,
-  "usage: typeinfo (expr)\n\
+  "-*- texinfo -*-\n\
+@deftypefn {Built-in Function} {} typeinfo (@var{expr})\n\
 \n\
-Return the type of the expression EXPR, as a string.  If EXPR is\n\
-omitted, return an array of strings containing all the currently\n\
-installed data types.")
+Return the type of the expression @var{expr}, as a string.  If\n\
+@var{EXPR}  is omitted, return an array of strings containing all the\n\
+currently installed data types.\n\
+@end deftypefn")
 {
   octave_value retval;
 
--- a/src/ov-usr-fcn.cc
+++ b/src/ov-usr-fcn.cc
@@ -479,8 +479,13 @@
 }
 
 DEFUN (va_arg, args, ,
-  "va_arg (): return next argument in a function that takes a\n\
-variable number of parameters")
+  "-*- texinfo -*-\n\
+@deftypefn {Built-in Function} {} va_arg ()\n\
+Return the value of hte next available argument and move the internal\n\
+pointer to the next argument.  It is an error to call @code{va_arg}\n\
+when ther eare no more arguments available, or in a function that\n\
+has not been declared to take a variable number of parameters.\n\
+@end deftypefn")
 {
   octave_value_list retval;
 
@@ -508,8 +513,13 @@
 }
 
 DEFUN (va_start, args, ,
-  "va_start (): reset the pointer to the list of optional arguments\n\
-to the beginning")
+  "-*- texinfo -*-\n\
+@deftypefn {Built-in Function} {} va_start ()\n\
+Position an internal pointer to the first unnamed argument in\n\
+functions that have been declared to accept a variable number of\n\
+arguments.  It is an error to call @code{va_start} in a function\n\
+that has not been declared to take a variable number of parameters.\n\
+@end deftypefn")
 {
   octave_value_list retval;
 
@@ -537,8 +547,15 @@
 }
 
 DEFUN (vr_val, args, ,
-  "vr_val (X): append X to the list of optional return values for a\n\
-function that allows a variable number of return values")
+  "-*- texinfo -*-\n\
+@deftypefn {Built-in Function} {} vr_val (@var{x})\n\
+Each time this function is called, it places the value of its argument\n\
+at the end of the list of values to return from the current\n\
+function.  Once @code{vr_val} has been called, there is no way to go\n\
+back to the beginning of the list and rewrite any of the return\n\
+values.  This function may only be called within functions that have\n\
+been declared to return an unspecified number of output arguments.\n\
+@end deftypefn")
 {
   octave_value_list retval;