Mercurial > octave
changeset 21319:8880d93010d8
Remove further uses of CLASS field in @deftypefn macro.
* errors.txi, external.txi, genpropdoc.m, intro.txi, tips.txi, ode23.m,
runge_kutta_23.m, gnuplot_binary.in:
Remove further uses of CLASS field in @deftypefn macro.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 22 Feb 2016 08:37:15 -0800 |
| parents | 280ea93d48dd |
| children | 241666557fec |
| files | doc/interpreter/errors.txi doc/interpreter/external.txi doc/interpreter/genpropdoc.m doc/interpreter/intro.txi doc/interpreter/tips.txi scripts/ode/ode23.m scripts/ode/private/runge_kutta_23.m scripts/plot/util/gnuplot_binary.in |
| diffstat | 8 files changed, 45 insertions(+), 46 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/errors.txi Sun Feb 21 09:08:33 2016 -0800 +++ b/doc/interpreter/errors.txi Mon Feb 22 08:37:15 2016 -0800 @@ -90,7 +90,7 @@ @example @group ## -*- texinfo -*- -## @@deftypefn @{Function File@} f (@@var@{arg1@}) +## @@deftypefn @{@} f (@@var@{arg1@}) ## Function help text goes here@dots{} ## @@end deftypefn function f (arg1) @@ -111,12 +111,12 @@ @print{} error: Invalid call to f. Correct usage is: @print{} -@print{} -- Function File: f (ARG1) +@print{} -- f (ARG1) @print{} @print{} @print{} Additional help for built-in functions and operators is @print{} available in the online version of the manual. Use the command -@print{} `doc <topic>' to search the manual index. +@print{} 'doc <topic>' to search the manual index. @print{} @print{} Help and information about Octave is also available on the WWW @print{} at http://www.octave.org and via the help@@octave.org
--- a/doc/interpreter/external.txi Sun Feb 21 09:08:33 2016 -0800 +++ b/doc/interpreter/external.txi Mon Feb 22 08:37:15 2016 -0800 @@ -1220,7 +1220,7 @@ @group DEFUN_DLD (do_what_i_want, args, nargout, "-*- texinfo -*-\n\ -@@deftypefn @{Function File@} @{@} do_what_i_say (@@var@{n@})\n\ +@@deftypefn @{@} @{@} do_what_i_say (@@var@{n@})\n\ A function that does what the user actually wants rather\n\ than what they requested.\n\ @@end deftypefn")
--- a/doc/interpreter/genpropdoc.m Sun Feb 21 09:08:33 2016 -0800 +++ b/doc/interpreter/genpropdoc.m Mon Feb 22 08:37:15 2016 -0800 @@ -15,7 +15,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{retval} =} genpropdoc (@var{OBJNAME}, @var{FILENAME}) +## @deftypefn {} {@var{retval} =} genpropdoc (@var{OBJNAME}, @var{FILENAME}) ## ## Print FILENAME texinfo source file associated to OBJNAME objects. This ## function is meant to be run for generating octave documentation
--- a/doc/interpreter/intro.txi Sun Feb 21 09:08:33 2016 -0800 +++ b/doc/interpreter/intro.txi Mon Feb 22 08:37:15 2016 -0800 @@ -580,9 +580,9 @@ Here is a description of an imaginary function @code{foo}: @need 4000 -@deftypefn {Function File} {} foo (@var{x}) -@deftypefnx {Function File} {} foo (@var{x}, @var{y}) -@deftypefnx {Function File} {} foo (@var{x}, @var{y}, @dots{}) +@deftypefn {} {} foo (@var{x}) +@deftypefnx {} {} foo (@var{x}, @var{y}) +@deftypefnx {} {} foo (@var{x}, @var{y}, @dots{}) The function @code{foo} subtracts @var{x} from @var{y}, then adds the remaining arguments to the result. @@ -659,10 +659,10 @@ @code{diary} command: @need 4000 -@deftypefn {Command} {} diary -@deftypefnx {Command} {} diary on -@deftypefnx {Command} {} diary off -@deftypefnx {Command} {} diary @var{filename} +@deftypefn {} {} diary +@deftypefnx {} {} diary on +@deftypefnx {} {} diary off +@deftypefnx {} {} diary @var{filename} Record a list of all commands @emph{and} the output they produce, mixed together just as they appear on the terminal.
--- a/doc/interpreter/tips.txi Sun Feb 21 09:08:33 2016 -0800 +++ b/doc/interpreter/tips.txi Mon Feb 22 08:37:15 2016 -0800 @@ -341,17 +341,15 @@ or online documentation will be greatly improved. The fundamental building block of Texinfo documentation strings is the -Texinfo-macro @code{@@deftypefn}, which takes three arguments: The class -the function is in, its output arguments, and the function's -signature. Typical classes for functions include @code{Function File} -for standard Octave functions, and @code{Loadable Function} for -dynamically linked functions. A skeletal Texinfo documentation string -therefore looks like this +Texinfo macro @code{@@deftypefn}. The first argument to the macro is +always blank. The second and third arguments are the function's output +arguments and the function signature. A skeletal Texinfo documentation +string looks like this @example @group -*- texinfo -*- -@@deftypefn @{Function File@} @{@@var@{ret@} =@} fn (@dots{}) +@@deftypefn @{@} @{@@var@{ret@} =@} fn (@dots{}) @@cindex index term Help text in Texinfo format. Code samples should be marked like @@code@{sample of code@} and variables should be marked @@ -370,7 +368,7 @@ This string signals Octave that the following text is in Texinfo format, and should be the first part of any help string in Texinfo format. -@item @@deftypefn @{class@} @dots{} @@end deftypefn +@item @@deftypefn @{@} @dots{} @@end deftypefn The entire help string should be enclosed within the block defined by deftypefn. @@ -487,8 +485,8 @@ @example @group -*- texinfo -*- -@@deftypefn @{Function File@} @{@@var@{a@} =@} fn (@@var@{x@}, @dots{}) -@@deftypefnx @{Function File@} @{@@var@{a@} =@} fn (@@var@{y@}, @dots{}) +@@deftypefn @{@} @{@@var@{a@} =@} fn (@@var@{x@}, @dots{}) +@@deftypefnx @{@} @{@@var@{a@} =@} fn (@@var@{y@}, @dots{}) Help text in Texinfo format. @@end deftypefn @end group @@ -501,8 +499,8 @@ @example -*- texinfo -*- -@@deftypefn @{Function File@} @{@@var@{c@} =@} nchoosek (@@var@{n@}, @@var@{k@}) -@@deftypefnx @{Function File@} @{@@var@{c@} =@} nchoosek (@@var@{set@}, @@var@{k@}) +@@deftypefn @{@} @{@@var@{c@} =@} nchoosek (@@var@{n@}, @@var@{k@}) +@@deftypefnx @{@} @{@@var@{c@} =@} nchoosek (@@var@{set@}, @@var@{k@}) Compute the binomial coefficient of @@var@{n@} or list all possible combinations of a @@var@{set@} of items. @@ -577,13 +575,14 @@ @c appear with info. @example - -- Function File: C = nchoosek (N, K) - -- Function File: C = nchoosek (SET, K) + -- C = nchoosek (N, K) + -- C = nchoosek (SET, K) + Compute the binomial coefficient of N or list all possible combinations of a SET of items. - If N is a scalar then calculate the binomial coefficient of N and - K which is defined as + If N is a scalar then calculate the binomial coefficient of N and K + which is defined as / \ | n | n (n-1) (n-2) ... (n-k+1) n! @@ -616,16 +615,16 @@ Programming Note: When calculating the binomial coefficient `nchoosek' works only for non-negative, integer arguments. Use `bincoeff' for non-integer and negative scalar arguments, or for - computing many binomial coefficients at once with vector inputs - for N or K. + computing many binomial coefficients at once with vector inputs for + N or K. See also: bincoeff, perms. @end example @noindent whereas in printed documentation using @TeX{} it will appear as -@deftypefn {Function File} {@var{c} =} nchoosek (@var{n}, @var{k}) -@deftypefnx {Function File} {@var{c} =} nchoosek (@var{set}, @var{k}) +@deftypefn {} {@var{c} =} nchoosek (@var{n}, @var{k}) +@deftypefnx {} {@var{c} =} nchoosek (@var{set}, @var{k}) Compute the binomial coefficient of @var{n} or list all possible combinations of a @var{set} of items.
--- a/scripts/ode/ode23.m Sun Feb 21 09:08:33 2016 -0800 +++ b/scripts/ode/ode23.m Mon Feb 22 08:37:15 2016 -0800 @@ -19,11 +19,11 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{t}, @var{y}] =} ode23 (@var{fun}, @var{trange}, @var{init}) -## @deftypefnx {Function File} {[@var{t}, @var{y}] =} ode23 (@var{fun}, @var{trange}, @var{init}, @var{ode_opt}) -## @deftypefnx {Function File} {[@var{t}, @var{y}] =} ode23 (@dots{}, @var{par1}, @var{par2}, @dots{}) -## @deftypefnx {Function File} {[@var{t}, @var{y}, @var{te}, @var{ye}, @var{ie}] =} ode23 (@dots{}) -## @deftypefnx {Function File} {@var{solution} =} ode23 (@dots{}) +## @deftypefn {} {[@var{t}, @var{y}] =} ode23 (@var{fun}, @var{trange}, @var{init}) +## @deftypefnx {} {[@var{t}, @var{y}] =} ode23 (@var{fun}, @var{trange}, @var{init}, @var{ode_opt}) +## @deftypefnx {} {[@var{t}, @var{y}] =} ode23 (@dots{}, @var{par1}, @var{par2}, @dots{}) +## @deftypefnx {} {[@var{t}, @var{y}, @var{te}, @var{ye}, @var{ie}] =} ode23 (@dots{}) +## @deftypefnx {} {@var{solution} =} ode23 (@dots{}) ## ## Solve a set of non-stiff Ordinary Differential Equations (non-stiff ODEs) ## with the well known explicit @nospell{Bogacki-Shampine} method of order 3.
--- a/scripts/ode/private/runge_kutta_23.m Sun Feb 21 09:08:33 2016 -0800 +++ b/scripts/ode/private/runge_kutta_23.m Mon Feb 22 08:37:15 2016 -0800 @@ -18,12 +18,12 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{t_next}, @var{x_next}] =} runge_kutta_23 (@var{@fun}, @var{t}, @var{x}, @var{dt}) -## @deftypefnx {Function File} {[@var{t_next}, @var{x_next}] =} runge_kutta_23 (@var{@fun}, @var{t}, @var{x}, @var{dt}, @var{options}) -## @deftypefnx {Function File} {[@var{t_next}, @var{x_next}] =} runge_kutta_23 (@var{@fun}, @var{t}, @var{x}, @var{dt}, @var{options}, @var{k_vals_in}) -## @deftypefnx {Function File} {[@var{t_next}, @var{x_next}] =} runge_kutta_23 (@var{@fun}, @var{t}, @var{x}, @var{dt}, @var{options}, @var{k_vals_in}, @var{t_next}) -## @deftypefnx {Function File} {[@var{t_next}, @var{x_next}, @var{x_est}] =} runge_kutta_23 (@dots{}) -## @deftypefnx {Function File} {[@var{t_next}, @var{x_next}, @var{x_est}, @var{k_vals_out}] =} runge_kutta_23 (@dots{}) +## @deftypefn {} {[@var{t_next}, @var{x_next}] =} runge_kutta_23 (@var{@fun}, @var{t}, @var{x}, @var{dt}) +## @deftypefnx {} {[@var{t_next}, @var{x_next}] =} runge_kutta_23 (@var{@fun}, @var{t}, @var{x}, @var{dt}, @var{options}) +## @deftypefnx {} {[@var{t_next}, @var{x_next}] =} runge_kutta_23 (@var{@fun}, @var{t}, @var{x}, @var{dt}, @var{options}, @var{k_vals_in}) +## @deftypefnx {} {[@var{t_next}, @var{x_next}] =} runge_kutta_23 (@var{@fun}, @var{t}, @var{x}, @var{dt}, @var{options}, @var{k_vals_in}, @var{t_next}) +## @deftypefnx {} {[@var{t_next}, @var{x_next}, @var{x_est}] =} runge_kutta_23 (@dots{}) +## @deftypefnx {} {[@var{t_next}, @var{x_next}, @var{x_est}, @var{k_vals_out}] =} runge_kutta_23 (@dots{}) ## ## This function can be used to integrate a system of ODEs with a given initial ## condition @var{x} from @var{t} to @var{t+dt}, with the Bogacki-Shampine
--- a/scripts/plot/util/gnuplot_binary.in Sun Feb 21 09:08:33 2016 -0800 +++ b/scripts/plot/util/gnuplot_binary.in Mon Feb 22 08:37:15 2016 -0800 @@ -17,10 +17,10 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Loadable Function} {[@var{prog}, @var{args}] =} gnuplot_binary () -## @deftypefnx {Loadable Function} {[@var{old_prog}, @var{old_args}] =} gnuplot_binary (@var{new_prog}, @var{arg1}, @dots{}) +## @deftypefn {} {[@var{prog}, @var{args}] =} gnuplot_binary () +## @deftypefnx {} {[@var{old_prog}, @var{old_args}] =} gnuplot_binary (@var{new_prog}, @var{arg1}, @dots{}) ## Query or set the name of the program invoked by the plot command when the -## graphics toolkit is set to "gnuplot". +## graphics toolkit is set to @qcode{"gnuplot"}. ## ## Additional arguments to pass to the external plotting program may also be ## given. The default value is @qcode{"gnuplot"} with no additional arguments.