Mercurial > hg > octave-lojdl
changeset 3446:5ee5afb3981a
[project @ 2000-01-17 09:42:43 by jwe]
author | jwe |
---|---|
date | Mon, 17 Jan 2000 09:42:48 +0000 |
parents | c3eed8ac845a |
children | 5c76d8f267f7 |
files | scripts/ChangeLog scripts/plot/bottom_title.m scripts/plot/sombrero.m scripts/plot/ylabel.m scripts/plot/zlabel.m scripts/polynomial/polyder.m scripts/strings/bin2dec.m scripts/strings/isletter.m scripts/strings/lower.m src/ChangeLog src/defaults.cc src/mappers.cc src/parse.y src/syscalls.cc src/toplev.cc src/utils.cc src/variables.cc |
diffstat | 17 files changed, 114 insertions(+), 43 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,7 @@ +2000-01-17 John W. Eaton <jwe@bevo.che.wisc.edu> + + * strings/bin2dec.m: Texinfoize doc string. + 2000-01-14 John W. Eaton <jwe@bevo.che.wisc.edu> * control/system/__abcddims__.m: Rename from
--- a/scripts/plot/bottom_title.m +++ b/scripts/plot/bottom_title.m @@ -24,7 +24,6 @@ ## ## makes a title with the given text at the bottom of the plot ## rather than the top. -## ## Author: Vinayak Dutt <Dutt.Vinayak@mayo.EDU> ## Adapted-By: jwe
--- a/scripts/plot/sombrero.m +++ b/scripts/plot/sombrero.m @@ -17,12 +17,16 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: sombrero (n) +## -*- texinfo -*- +## @deftypefn {Function File} {} sombrero (@var{n}) ## -## Draw a `sombrero' in three dimensions using n grid lines. The +## Draw a `sombrero' in three dimensions using @var{n} grid lines. The ## function plotted is ## +## @example ## z = sin (sqrt (x^2 + y^2)) / (sqrt (x^2 + y^2)) +## @end example +## @end deftypefn ## Author: jwe
--- a/scripts/plot/ylabel.m +++ b/scripts/plot/ylabel.m @@ -19,9 +19,6 @@ ## See xlabel. -## See also: plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, gplot, gsplot, replot, xlabel, title - ## Author: jwe function ylabel (text)
--- a/scripts/plot/zlabel.m +++ b/scripts/plot/zlabel.m @@ -19,9 +19,6 @@ ## See xlabel. -## See also: plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, gplot, gsplot, replot, xlabel, title - ## Author: Vinayak Dutt <Dutt.Vinayak@mayo.EDU> ## Created: 3 July 95 ## Adapted-By: jwe
--- a/scripts/polynomial/polyder.m +++ b/scripts/polynomial/polyder.m @@ -17,9 +17,7 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: polyder (p) -## -## SEE ALSO: polyderiv +## See polyderiv. ## Author: jwe
--- a/scripts/strings/bin2dec.m +++ b/scripts/strings/bin2dec.m @@ -17,10 +17,16 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: bin2dec (x) +## -*- texinfo -*- +## @deftypefn {Function File} {} bin2dec (@var{s}) +## Return the decimal number corresponding to the binary number +## represented by the string @var{s}. For example, ## -## Returns the decimal number corresponding to the binary number in -## quotes. For example, bin2dec ("1110") returns 14. +## @example +## bin2dec ("1110") +## @result{} 14 +## @end example +## @end deftypefn ## Author: Kurt Hornik <Kurt.Hornik@ci.tuwien.ac.at> ## Adapted-By: jwe
--- a/scripts/strings/isletter.m +++ b/scripts/strings/isletter.m @@ -17,6 +17,7 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. +## -*- texinfo -*- ## @deftypefn {Function File } { @var{bool} =} isletter(@var{s}) ## Returns true if @var{s} is a letter false otherwise. ## @end deftypefn
--- a/scripts/strings/lower.m +++ b/scripts/strings/lower.m @@ -17,6 +17,7 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. +## -*- texinfo -*- ## @deftypefn {Function File} {@var{s} =} lower(@var{S}) ## @end deftypefn ## @seealso{tolower}
--- a/src/ChangeLog +++ b/src/ChangeLog @@ -2,9 +2,13 @@ * DLD-FUNCTIONS/gammainc.cc (Fgammainc): Texinfoize doc string. * ov-typeinfo.cc (Ftypeinfo): Ditto. - - * DLD-FUNCTIONS/minmax.cc (Fmax, Fmin): Texinfoize doc strings. + * parse.y (Vwarn_future_time_stamp): Ditto. + * DLD-FUNCTIONS/minmax.cc (Fmax, Fmin): Ditto. * ov-usr-fcn.cc (Fva_arg, Fva_start, Fvr_val): Ditto. + * defaults.cc (VOCTAVE_HOME, Frehash): Ditto. + * 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. * pt-plot.cc (Fgraw, Fgset, Fgshow, Vgnuplot_command_plot, Vgnuplot_command_replot, Vgnuplot_command_splot,
--- a/src/defaults.cc +++ b/src/defaults.cc @@ -496,17 +496,24 @@ @end defvr"); DEFCONST (OCTAVE_HOME, Voctave_home, - "top-level Octave installation directory"); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} OCTAVE_HOME\n\ +The name of the top-level Octave installation directory.\n\ +@end defvr"); DEFCONSTX ("OCTAVE_VERSION", SBV_OCTAVE_VERSION, OCTAVE_VERSION, "-*- texinfo -*-\n\ @defvr {Built-in Variable} OCTAVE_VERSION\n\ The version number of Octave, as a string.\n\ @end defvr"); + } DEFUN (rehash, , , - "rehash (): reinitialize LOADPATH directory cache") + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {} rehash ()\n\ +Reinitialize Octave's @code{LOADPATH} directory cache.\n\ +@end deftypefn") { octave_value_list retval;
--- a/src/mappers.cc +++ b/src/mappers.cc @@ -171,7 +171,7 @@ DEFUN_MAPPER (arg, 0, 0, 0, arg, arg, 0, 0.0, 0.0, 0, "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} angle (@var{z})\n\ +@deftypefn {Mapping Function} {} arg (@var{z})\n\ Compute the argument of @var{z}, defined as\n\ @iftex\n\ @tex\n\
--- a/src/parse.y +++ b/src/parse.y @@ -3497,7 +3497,11 @@ @end defvr"); DEFVAR (warn_future_time_stamp, 1.0, warn_future_time_stamp, - "warn if a function file has a time stamp that is in the future"); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} warn_future_time_stamp\n\ +If the value of this variable is nonzero, Octave will print a warning\n\ +if it finds a function file with a time stamp that is in the future.\n\ +@end defvr"); DEFVAR (warn_missing_semicolon, 0.0, warn_missing_semicolon, "-*- texinfo -*-\n\
--- a/src/syscalls.cc +++ b/src/syscalls.cc @@ -878,78 +878,109 @@ { #if defined (F_DUPFD) DEFCONSTX ("F_DUPFD", SBV_F_DUPFD, static_cast<double> (F_DUPFD), - ""); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} F_DUPFD\n\ +@end defvr"); #endif #if defined (F_GETFD) DEFCONSTX ("F_GETFD", SBV_F_GETFD, static_cast<double> (F_GETFD), - ""); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} F_GETFD\n\ +@end defvr"); #endif #if defined (F_GETFL) DEFCONSTX ("F_GETFL", SBV_F_GETFL, static_cast<double> (F_GETFL), - ""); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} F_GETFL\n\ +@end defvr"); #endif #if defined (F_SETFD) DEFCONSTX ("F_SETFD", SBV_F_SETFD, static_cast<double> (F_SETFD), - ""); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} F_SETFD\n\ +@end defvr"); #endif #if defined (F_SETFL) DEFCONSTX ("F_SETFL", SBV_F_SETFL, static_cast<double> (F_SETFL), - ""); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} F_SETFL\n\ +@end defvr"); #endif #if defined (O_APPEND) DEFCONSTX ("O_APPEND", SBV_O_APPEND, static_cast<double> (O_APPEND), - ""); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} O_APPEND\n\ +@end defvr"); #endif #if defined (O_ASYNC) DEFCONSTX ("O_ASYNC", SBV_O_ASYNC, static_cast<double> (O_ASYNC), - ""); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} O_ASYNC\n\ +@end defvr"); #endif #if defined (O_CREAT) DEFCONSTX ("O_CREAT", SBV_O_CREAT, static_cast<double> (O_CREAT), - ""); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} O_CREAT\n\ +@end defvr"); #endif #if defined (O_EXCL) DEFCONSTX ("O_EXCL", SBV_O_EXCL, static_cast<double> (O_EXCL), - ""); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} O_EXCL\n\ +@end defvr"); #endif #if defined (O_NONBLOCK) DEFCONSTX ("O_NONBLOCK", SBV_O_NONBLOCK, static_cast<double> (O_NONBLOCK), - ""); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} O_NONBLOCK\n\ +@end defvr"); #endif #if defined (O_RDONLY) DEFCONSTX ("O_RDONLY", SBV_O_RDONLY, static_cast<double> (O_RDONLY), - ""); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} O_RDONLY\n\ +@end defvr"); #endif #if defined (O_RDWR) DEFCONSTX ("O_RDWR", SBV_O_RDWR, static_cast<double> (O_RDWR), - ""); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} O_RDWR\n\ +@end defvr"); #endif #if defined (O_SYNC) DEFCONSTX ("O_SYNC", SBV_O_SYNC, static_cast<double> (O_SYNC), - ""); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} O_SYNC\n\ +@end defvr"); #endif #if defined (O_TRUNC) DEFCONSTX ("O_TRUNC", SBV_O_TRUNC, static_cast<double> (O_TRUNC), - ""); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} O_TRUNC\n\ +@end defvr"); #endif #if defined (O_WRONLY) DEFCONSTX ("O_WRONLY", SBV_O_WRONLY, static_cast<double> (O_WRONLY), - ""); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} O_WRONLY\n\ +@end defvr"); #endif + } /*
--- a/src/toplev.cc +++ b/src/toplev.cc @@ -173,7 +173,10 @@ } DEFUN_TEXT (casesen, args, , - "casesen [on|off]") + "-*- texinfo -*-\n\ +@deffn {Command} casesen arg\n\ +Provided for compatibility with Matlab, but does nothing.\n\ +@end deffn") { octave_value_list retval; @@ -271,7 +274,10 @@ DEFALIAS (exit, quit); DEFUN (warranty, , , - "warranty (): describe copying conditions") + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {} warranty ()\n\ +Describe the conditions for copying and distributing Octave.\n\ +@end deftypefn") { octave_value_list retval;
--- a/src/utils.cc +++ b/src/utils.cc @@ -238,9 +238,12 @@ } DEFUN (file_in_loadpath, args, , - "file_in_loadpath (NAME)\n\ + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {} file_in_loadpath (@var{name})\n\ \n\ -Look up NAME in LOADPATH. See also file_in_path") +Look up @var{name} in Octave's @code{LOADPATH}.\n\ +@end deftypefn\n\ +@seealso{file_in_path}") { octave_value_list retval; @@ -437,7 +440,10 @@ } DEFUN (do_string_escapes, args, , - "do_string_escapes (STRING)") + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {} do_string_escapes (@var{string})\n\ +Convert special characters in @var{string} to their escaped forms.\n\ +@end deftypefn") { octave_value retval;
--- a/src/variables.cc +++ b/src/variables.cc @@ -1223,7 +1223,10 @@ } DEFUN (__dump_symtab_info__, args, , - "__dump_symtab_info__ (): print raw symbol table statistices") + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {} __dump_symtab_info__ ()\n\ +Print raw symbol table statistices.\n\ +@end deftypefn") { octave_value_list retval; @@ -1247,7 +1250,10 @@ } DEFUN (__dump_symbol_info__, args, , - "__dump_symbol_info__ (NAME)") + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {} __dump_symbol_info__ (@var{name})\n\ +Print symbol table information for the symbol @var{name}. +@end deftypefn") { octave_value_list retval;