changeset 3443:bf22deaf04ed

[project @ 2000-01-17 08:28:27 by jwe]
author jwe
date Mon, 17 Jan 2000 08:28:27 +0000
parents 86e1068c2abb
children fa0d84558faa
files src/ChangeLog src/DLD-FUNCTIONS/minmax.cc src/data.cc
diffstat 3 files changed, 38 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,5 +1,7 @@
 2000-01-17  John W. Eaton  <jwe@bevo.che.wisc.edu>
 
+	* DLD-FUNCTIONS/minmax.cc (Fmax, Fmin): Texinfoize doc strings.
+
 	* pt-plot.cc (Fgraw, Fgset, Fgshow, Vgnuplot_command_plot, 
 	Vgnuplot_command_replot, Vgnuplot_command_splot,
 	Vgnuplot_command_using, Vgnuplot_command_with,
--- a/src/DLD-FUNCTIONS/minmax.cc
+++ b/src/DLD-FUNCTIONS/minmax.cc
@@ -274,7 +274,20 @@
 }
 
 DEFUN_DLD (min, args, nargout,
-  "min (X): minimum value(s) of a vector (matrix)")
+  "-*- texinfo -*-\n\
+For a vector argument, return the minimum value.  For a matrix\n\
+argument, return the minimum value from each column, as a row\n\
+vector.  Thus,\n\
+\n\
+@example\n\
+min (min (@var{x}))\n\
+@end example\n\
+\n\
+@noindent\n\
+returns the smallest element of @var{x}.\n\
+\n\
+For complex arguments, the magnitude of the elements are used for\n\
+comparison.")
 {
   octave_value_list retval;
 
@@ -488,7 +501,20 @@
 }
 
 DEFUN_DLD (max, args, nargout,
-  "max (X): maximum value(s) of a vector (matrix)")
+  "-*- texinfo -*-\n\
+For a vector argument, return the maximum value.  For a matrix\n\
+argument, return the maximum value from each column, as a row\n\
+vector.  Thus,\n\
+\n\
+@example\n\
+max (max (@var{x}))\n\
+@end example\n\
+\n\
+@noindent\n\
+returns the largest element of @var{x}.\n\
+\n\
+For complex arguments, the magnitude of the elements are used for\n\
+comparison.")
 {
   octave_value_list retval;
 
--- a/src/data.cc
+++ b/src/data.cc
@@ -1332,7 +1332,10 @@
 @end defvr");
 
   DEFCONST (false, false,
-    "logical false value");
+    "-*- texinfo -*-\n\
+@defvr {Built-in Variable} false\n\
+Logical false value.\n\
+@end defvr");
 
   DEFCONST (i, Complex (0.0, 1.0),
     IMAGINARY_DOC_STRING);
@@ -1392,7 +1395,10 @@
 @end defvr");
 
   DEFCONST (true, true,
-    "logical true value");
+    "-*- texinfo -*-\n\
+@defvr {Built-in Variable} true\n\
+Logical true value.\n\
+@end defvr");
 
 }