Mercurial > hg > octave-lojdl
changeset 16489:36dba9be680b
doc: Make documentation compatible with Texinfo 5.0 (bug #38392)
* scripts/audio/wavread.m, scripts/miscellaneous/getappdata.m,
scripts/miscellaneous/license.m, scripts/miscellaneous/ver.m,
scripts/plot/daspect.m, scripts/plot/graphics_toolkit.m,
scripts/plot/pbaspect.m, scripts/polynomial/polyval.m,
scripts/polynomial/splinefit.m, scripts/set/union.m, scripts/signal/freqz.m:
Moved @deftypefnx entries to always immediately follow @deftypefn.
author | Amod Mulay <amodmulay1@gmail.com> |
---|---|
date | Fri, 22 Mar 2013 17:07:00 -0400 |
parents | d4ce14c19c2c |
children | f50fe9c50f55 |
files | scripts/audio/wavread.m scripts/miscellaneous/getappdata.m scripts/miscellaneous/license.m scripts/miscellaneous/ver.m scripts/plot/daspect.m scripts/plot/graphics_toolkit.m scripts/plot/pbaspect.m scripts/polynomial/polyval.m scripts/polynomial/splinefit.m scripts/set/union.m scripts/signal/freqz.m |
diffstat | 11 files changed, 94 insertions(+), 60 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/audio/wavread.m +++ b/scripts/audio/wavread.m @@ -18,21 +18,26 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{y} =} wavread (@var{filename}) +## @deftypefnx {Function File} {[@var{y}, @var{Fs}, @var{bps}] =} wavread (@var{filename}) +## @deftypefnx {Function File} {[@dots{}] =} wavread (@var{filename}, @var{n}) +## @deftypefnx {Function File} {[@dots{}] =} wavread (@var{filename}, @var{n1} @var{n2}) +## @deftypefnx {Function File} {[@var{samples}, @var{channels}] =} wavread (@var{filename}, "size") +## ## Load the RIFF/WAVE sound file @var{filename}, and return the samples ## in vector @var{y}. If the file contains multichannel data, then ## @var{y} is a matrix with the channels represented as columns. ## -## @deftypefnx {Function File} {[@var{y}, @var{Fs}, @var{bps}] =} wavread (@var{filename}) +## @code{[@var{y}, @var{Fs}, @var{bps}] = wavread (@var{filename})} ## Additionally return the sample rate (@var{fs}) in Hz and the number of bits ## per sample (@var{bps}). ## -## @deftypefnx {Function File} {[@dots{}] =} wavread (@var{filename}, @var{n}) +## @code{[@dots{}] = wavread (@var{filename}, @var{n})} ## Read only the first @var{n} samples from each channel. ## -## @deftypefnx {Function File} {[@dots{}] =} wavread (@var{filename}, @var{n1} @var{n2}) +## @code{wavread (@var{filename}, @var{n1} @var{n2})} ## Read only samples @var{n1} through @var{n2} from each channel. ## -## @deftypefnx {Function File} {[@var{samples}, @var{channels}] =} wavread (@var{filename}, "size") +## @code{[@var{samples}, @var{channels}] = wavread (@var{filename}, "size")} ## Return the number of samples (@var{n}) and channels (@var{ch}) ## instead of the audio data. ## @seealso{wavwrite}
--- a/scripts/miscellaneous/getappdata.m +++ b/scripts/miscellaneous/getappdata.m @@ -16,10 +16,12 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{value} =} getappdata (@var{h}, @var{name}) +## @deftypefnx {Function File} {@var{appdata} =} getappdata (@var{h}) +## ## Return the @var{value} for named application data for the object(s) with ## handle(s) @var{h}. -## @deftypefnx {Function File} {@var{appdata} =} getappdata (@var{h}) -## Return a structure, @var{appdata}, whose fields correspond to the appdata +## +## @code{getappdata(@var{h})} returns a structure, @var{appdata}, whose fields correspond to the appdata ## properties. ## @end deftypefn
--- a/scripts/miscellaneous/license.m +++ b/scripts/miscellaneous/license.m @@ -18,20 +18,26 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} license +## @deftypefnx {Function File} {} license ("inuse") +## @deftypefnx {Function File} {@var{retval} =} license ("inuse") +## @deftypefnx {Function File} {@var{retval} =} license ("test", @var{feature}) +## @deftypefnx {Function File} {} license ("test", @var{feature}, @var{toggle}) +## @deftypefnx {Function File} {@var{retval} =} license ("checkout", @var{feature}) +## ## Display the license of Octave. ## -## @deftypefnx {Function File} {} license ("inuse") +## @code{license ("inuse")} ## Display a list of packages currently being used. ## -## @deftypefnx {Function File} {@var{retval} =} license ("inuse") +## @code{@var{retval} = license ("inuse")} ## Return a structure containing the fields @code{feature} and @code{user}. ## -## @deftypefnx {Function File} {@var{retval} =} license ("test", @var{feature}) +## @code{@var{retval} = license ("test", @var{feature})} ## Return 1 if a license exists for the product identified by the string ## @var{feature} and 0 otherwise. The argument @var{feature} is case ## insensitive and only the first 27 characters are checked. ## -## @deftypefnx {Function File} {} license ("test", @var{feature}, @var{toggle}) +## @code{license ("test", @var{feature}, @var{toggle})} ## Enable or disable license testing for @var{feature}, depending on ## @var{toggle}, which may be one of: ## @@ -44,7 +50,7 @@ ## Future tests for the specified license of @var{feature} return 0. ## @end table ## -## @deftypefnx {Function File} {@var{retval} =} license ("checkout", @var{feature}) +## @code{@var{retval} = license ("checkout", @var{feature})} ## Check out a license for @var{feature}, returning 1 on success and 0 ## on failure. ##
--- a/scripts/miscellaneous/ver.m +++ b/scripts/miscellaneous/ver.m @@ -18,11 +18,15 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} ver () +## @deftypefnx {Function File} {v =} ver () +## @deftypefnx {Function File} {v =} ver ("Octave") +## @deftypefnx {Function File} {v =} ver (@var{package}) +## ## Display a header containing the current Octave version number, license ## string and operating system, followed by the installed package names, ## versions, and installation directories. ## -## @deftypefnx {Function File} {v =} ver () +## @code{v = ver ()} ## Return a vector of structures, respecting Octave and each installed package. ## The structure includes the following fields. ## @@ -40,10 +44,10 @@ ## Date respecting the version/revision. ## @end table ## -## @deftypefnx {Function File} {v =} ver ("Octave") +## @code{v = ver ("Octave")} ## Return version information for Octave only. ## -## @deftypefnx {Function File} {v =} ver (@var{package}) +## @code{v = ver (@var{package})} ## Return version information for @var{package}. ## ## @seealso{version, octave_config_info}
--- a/scripts/plot/daspect.m +++ b/scripts/plot/daspect.m @@ -18,22 +18,23 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} daspect (@var{data_aspect_ratio}) -## Set the data aspect ratio of the current axes. The aspect ratio is -## a normalized 3-element vector representing the span of the x, y, and -## z-axes limits. -## -## @deftypefnx {Function File} {@var{data_aspect_ratio} =} daspect ( ) -## Return the data aspect ratio of the current axes. -## +## @deftypefnx {Function File} {@var{data_aspect_ratio} =} daspect () ## @deftypefnx {Function File} {} daspect (@var{mode}) -## Set the data aspect ratio mode of the current axes. -## ## @deftypefnx {Function File} {@var{data_aspect_ratio_mode} =} daspect ("mode") -## Return the data aspect ratio mode of the current axes. -## ## @deftypefnx {Function File} {} daspect (@var{hax}, @dots{}) -## Use the axes, with handle @var{hax}, instead of the current axes. -## +## @code{daspect} sets the data aspect ratio of the current axes. The aspect +## ratio is a normalized 3-element vector representing the span of the x, y, and +## z-axes limits. +## +## When called without any arguments it returns data aspect ratio of the current axes. +## +## @code{(daspect (@var{mode}))} sets the data aspect ratio mode of the current axes. +## +## @code{daspect ("mode")} returns the data aspect ratio mode of the current axes. +## +## @code{daspect (@var{hax}, @dots{})} uses the axes, with handle @var{hax}, +## instead of the current axes. +## ## @seealso{axis, pbaspect, xlim, ylim, zlim} ## @end deftypefn
--- a/scripts/plot/graphics_toolkit.m +++ b/scripts/plot/graphics_toolkit.m @@ -18,17 +18,23 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{name} =} graphics_toolkit () -## Return the default graphics toolkit. The default graphics toolkit value -## is assigned to new figures. ## @deftypefnx {Function File} {@var{name} =} graphics_toolkit (@var{hlist}) -## Return the graphics toolkits for the figures with handles @var{hlist}. ## @deftypefnx {Function File} {} graphics_toolkit (@var{name}) -## Set the default graphics toolkit to @var{name}. If the toolkit is not -## already loaded, it is initialized by calling the function -## @code{__init_@var{name}__}. ## @deftypefnx {Function File} {} graphics_toolkit (@var{hlist}, @var{name}) -## Set the graphics toolkit for the figures with handles @var{hlist} to -## @var{name}. +## +## @code{graphics_toolkit (@var{hlist})} returns the default graphics toolkit. +## The default graphics toolkit value is assigned to new figures. +## +## @code{graphics_toolkit (@var{name})} returns the graphics toolkits +## for the figures with handles @var{hlist}. +## +## @code{graphics_toolkit (@var{name})} sets the default graphics toolkit +## to @var{name}. If the toolkit is not already loaded, it is initialized +## by calling the function @code{__init_@var{name}__}. +## +## @code{graphics_toolkit (@var{hlist}, @var{name})} sets the graphics toolkit +## for the figures with handles @var{hlist} to @var{name}. +## ## @seealso{available_graphics_toolkits} ## @end deftypefn
--- a/scripts/plot/pbaspect.m +++ b/scripts/plot/pbaspect.m @@ -18,21 +18,24 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} pbaspect (@var{plot_box_aspect_ratio}) +## @deftypefnx {Function File} {@var{plot_box_aspect_ratio} =} pbaspect ( ) +## @deftypefnx {Function File} {} pbaspect (@var{mode}) +## @deftypefnx {Function File} {@var{plot_box_aspect_ratio_mode} =} pbaspect ("mode") +## @deftypefnx {Function File} {} pbaspect (@var{hax}, @dots{}) +## ## Set the plot box aspect ratio of the current axes. The aspect ratio ## is a normalized 3-element vector representing the rendered lengths of ## the x, y, and z-axes. -## -## @deftypefnx {Function File} {@var{plot_box_aspect_ratio} =} pbaspect ( ) -## Return the plot box aspect ratio of the current axes. -## -## @deftypefnx {Function File} {} pbaspect (@var{mode}) -## Set the plot box aspect ratio mode of the current axes. -## -## @deftypefnx {Function File} {@var{plot_box_aspect_ratio_mode} =} pbaspect ("mode") -## Return the plot box aspect ratio mode of the current axes. -## -## @deftypefnx {Function File} {} pbaspect (@var{hax}, @dots{}) -## Use the axes, with handle @var{hax}, instead of the current axes. +## +## When called without any arguments, returns the plot box aspect ratio of +## the current axes. +## +## @code{pbaspect(@var{mode})} sets the plot box aspect ratio mode of the current axes. +## +## @code{pbaspect ("mode")} returns the plot box aspect ratio mode of the current axes. +## +## @code{pbaspect (@var{hax}, @dots{})} uses the axes, with handle @var{hax}, instead +## of the current axes. ## ## @seealso{axis, daspect, xlim, ylim, zlim} ## @end deftypefn
--- a/scripts/polynomial/polyval.m +++ b/scripts/polynomial/polyval.m @@ -19,19 +19,21 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{y} =} polyval (@var{p}, @var{x}) ## @deftypefnx {Function File} {@var{y} =} polyval (@var{p}, @var{x}, [], @var{mu}) +## @deftypefnx {Function File} {[@var{y}, @var{dy}] =} polyval (@var{p}, @var{x}, @var{s}) +## @deftypefnx {Function File} {[@var{y}, @var{dy}] =} polyval (@var{p}, @var{x}, @var{s}, @var{mu}) +## ## Evaluate the polynomial @var{p} at the specified values of @var{x}. When ## @var{mu} is present, evaluate the polynomial for ## (@var{x}-@var{mu}(1))/@var{mu}(2). ## If @var{x} is a vector or matrix, the polynomial is evaluated for each of ## the elements of @var{x}. ## -## @deftypefnx {Function File} {[@var{y}, @var{dy}] =} polyval (@var{p}, @var{x}, @var{s}) -## @deftypefnx {Function File} {[@var{y}, @var{dy}] =} polyval (@var{p}, @var{x}, @var{s}, @var{mu}) ## In addition to evaluating the polynomial, the second output ## represents the prediction interval, @var{y} +/- @var{dy}, which ## contains at least 50% of the future predictions. To calculate the ## prediction interval, the structured variable @var{s}, originating ## from @code{polyfit}, must be supplied. +## ## @seealso{polyvalm, polyaffine, polyfit, roots, poly} ## @end deftypefn
--- a/scripts/polynomial/splinefit.m +++ b/scripts/polynomial/splinefit.m @@ -18,6 +18,13 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{pp} =} splinefit (@var{x}, @var{y}, @var{breaks}) +## @deftypefnx {Function File} {@var{pp} =} splinefit (@var{x}, @var{y}, @var{p}) +## @deftypefnx {Function File} {@var{pp} =} splinefit (@dots{}, "periodic", @var{periodic}) +## @deftypefnx {Function File} {@var{pp} =} splinefit (@dots{}, "robust", @var{robust}) +## @deftypefnx {Function File} {@var{pp} =} splinefit (@dots{}, "beta", @var{beta}) +## @deftypefnx {Function File} {@var{pp} =} splinefit (@dots{}, "order", @var{order}) +## @deftypefnx {Function File} {@var{pp} =} splinefit (@dots{}, "constraints", @var{constraints}) +## ## Fit a piecewise cubic spline with breaks (knots) @var{breaks} to the ## noisy data, @var{x} and @var{y}. @var{x} is a vector, and @var{y} ## a vector or N-D array. If @var{y} is an N-D array, then @var{x}(j) @@ -26,17 +33,10 @@ ## The fitted spline is returned as a piecewise polynomial, @var{pp}, and ## may be evaluated using @code{ppval}. ## -## @deftypefnx {Function File} {@var{pp} =} splinefit (@var{x}, @var{y}, @var{p}) ## @var{p} is a positive integer defining the number of intervals along @var{x}, ## and @var{p}+1 is the number of breaks. The number of points in each interval ## differ by no more than 1. ## -## @deftypefnx {Function File} {@var{pp} =} splinefit (@dots{}, "periodic", @var{periodic}) -## @deftypefnx {Function File} {@var{pp} =} splinefit (@dots{}, "robust", @var{robust}) -## @deftypefnx {Function File} {@var{pp} =} splinefit (@dots{}, "beta", @var{beta}) -## @deftypefnx {Function File} {@var{pp} =} splinefit (@dots{}, "order", @var{order}) -## @deftypefnx {Function File} {@var{pp} =} splinefit (@dots{}, "constraints", @var{constraints}) -## ## The optional property @var{periodic} is a logical value which specifies ## whether a periodic boundary condition is applied to the spline. The ## length of the period is @code{max (@var{breaks}) - min (@var{breaks})}.
--- a/scripts/set/union.m +++ b/scripts/set/union.m @@ -20,6 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} union (@var{a}, @var{b}) ## @deftypefnx {Function File} {} union (@var{a}, @var{b}, "rows") +## @deftypefnx {Function File} {[@var{c}, @var{ia}, @var{ib}] =} union (@var{a}, @var{b}) +## ## Return the set of elements that are in either of the sets @var{a} and ## @var{b}. @var{a}, @var{b} may be cell arrays of string(s). ## For example: @@ -44,7 +46,6 @@ ## @end group ## @end example ## -## @deftypefnx {Function File} {[@var{c}, @var{ia}, @var{ib}] =} union (@var{a}, @var{b}) ## ## Return index vectors @var{ia} and @var{ib} such that @code{a(ia)} and ## @code{b(ib)} are disjoint sets whose union is @var{c}.
--- a/scripts/signal/freqz.m +++ b/scripts/signal/freqz.m @@ -18,6 +18,10 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{h}, @var{w}] =} freqz (@var{b}, @var{a}, @var{n}, "whole") +## @deftypefnx {Function File} {@var{h} =} freqz (@var{b}, @var{a}, @var{w}) +## @deftypefnx {Function File} {[@dots{}] =} freqz (@dots{}, @var{Fs}) +## @deftypefnx {Function File} {} freqz (@dots{}) +## ## Return the complex frequency response @var{h} of the rational IIR filter ## whose numerator and denominator coefficients are @var{b} and @var{a}, ## respectively. The response is evaluated at @var{n} angular frequencies @@ -49,16 +53,16 @@ ## For fastest computation, @var{n} should factor into a small number of ## small primes. ## -## @deftypefnx {Function File} {@var{h} =} freqz (@var{b}, @var{a}, @var{w}) +## @code{freqz (@var{b}, @var{a}, @var{w})} ## Evaluate the response at the specific frequencies in the vector @var{w}. ## The values for @var{w} are measured in radians. ## -## @deftypefnx {Function File} {[@dots{}] =} freqz (@dots{}, @var{Fs}) +## @code{[@dots{}] = freqz (@dots{}, @var{Fs})} ## Return frequencies in Hz instead of radians assuming a sampling rate ## @var{Fs}. If you are evaluating the response at specific frequencies ## @var{w}, those frequencies should be requested in Hz rather than radians. ## -## @deftypefnx {Function File} {} freqz (@dots{}) +## @code{freqz (@dots{})} ## Plot the pass band, stop band and phase response of @var{h} rather ## than returning them. ## @end deftypefn