Mercurial > octave
changeset 25039:40a65b30fadf stable
maint: Match variable names in documentation to those in function prototype.
* toascii.m, logspace.m, __splinen__.m, __fltk_file_filter__.m,
__uigetfile_fltk__.m, __uiobject_split_args__.m, __uiputfile_fltk__.m,
__makeinfo__.m, __fdjac__.m, __getlegenddata__.m, __axis_label__.m,
__errplot__.m, __interp_cube__.m, __pltopt__.m, __gnuplot_get_var__.m,
__gnuplot_has_terminal__.m, isstring.m, __run_test_suite__.m:
Change names of either variables in function prototype or documentation
variables in @deftypefn statements so that code and documentation are aligne.
line wrap: on
line diff
--- a/scripts/deprecated/toascii.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/deprecated/toascii.m Wed Mar 28 13:11:00 2018 -0700 @@ -17,12 +17,12 @@ ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {} toascii (@var{s}) +## @deftypefn {} {} toascii (@var{str}) ## ## @code{toascii} is deprecated and will be removed in Octave version 4.8. ## Use @code{double} instead. ## -## Return ASCII representation of @var{s} in a matrix. +## Return ASCII representation of @var{str} in a matrix. ## ## For example: ##
--- a/scripts/general/logspace.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/general/logspace.m Wed Mar 28 13:11:00 2018 -0700 @@ -67,23 +67,23 @@ ## Author: jwe -function retval = logspace (base, limit, n = 50) +function retval = logspace (a, b, n = 50) if (nargin != 2 && nargin != 3) print_usage (); endif - if (! (isscalar (base) && isscalar (limit) && isscalar (n))) - error ("logspace: arguments BASE, LIMIT, and N must be scalars"); + if (! (isscalar (a) && isscalar (b) && isscalar (n))) + error ("logspace: arguments A, B, and N must be scalars"); endif npoints = fix (n); - if (limit == pi) - limit = log10 (pi); + if (b == pi) + b = log10 (pi); endif - retval = 10 .^ (linspace (base, limit, npoints)); + retval = 10 .^ (linspace (a, b, npoints)); endfunction
--- a/scripts/general/private/__splinen__.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/general/private/__splinen__.m Wed Mar 28 13:11:00 2018 -0700 @@ -19,7 +19,7 @@ ## Undocumented internal function. ## -*- texinfo -*- -## @deftypefn {} {@var{yi} =} __splinen__ (@var{x}, @var{y}, @var{xi}) +## @deftypefn {} {@var{yi} =} __splinen__ (@var{x}, @var{y}, @var{xi}, @var{extrapval}, @var{f}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/gui/private/__fltk_file_filter__.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/gui/private/__fltk_file_filter__.m Wed Mar 28 13:11:00 2018 -0700 @@ -17,7 +17,7 @@ ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {@var{filterspec} =} __fltk_file_filter__ (@var{filter}) +## @deftypefn {} {@var{filterspec} =} __fltk_file_filter__ (@var{file_filter}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/gui/private/__uigetfile_fltk__.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/gui/private/__uigetfile_fltk__.m Wed Mar 28 13:11:00 2018 -0700 @@ -17,7 +17,7 @@ ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {[@var{fname}, @var{fpath}, @var{fltidx}] =} __uigetfile_fltk__ () +## @deftypefn {} {[@var{fname}, @var{fpath}, @var{fltidx}] =} __uigetfile_fltk__ (@var{filters}, @var{title}, @var{defval}, @var{position}, @var{multiselect}, @var{defdir}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/gui/private/__uiobject_split_args__.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/gui/private/__uiobject_split_args__.m Wed Mar 28 13:11:00 2018 -0700 @@ -17,7 +17,7 @@ ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {[@var{p}, @var{args}] =} __uiobject_split_args__ (@var{who}, @var{args}, @var{parent_type}, @var{use_gcf}) +## @deftypefn {} {[@var{p}, @var{args}] =} __uiobject_split_args__ (@var{who}, @var{in_args}, @var{parent_type}, @var{use_gcf}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/gui/private/__uiputfile_fltk__.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/gui/private/__uiputfile_fltk__.m Wed Mar 28 13:11:00 2018 -0700 @@ -17,7 +17,7 @@ ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {[@var{fname}, @var{fpath}, @var{fltidx}] =} __uiputfile_fltk__ () +## @deftypefn {} {[@var{fname}, @var{fpath}, @var{fltidx}] =} __uiputfile_fltk__ (@var{filters}, @var{title}, @var{defval}, @var{position}, @var{tag}, @var{defdir}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/help/__makeinfo__.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/help/__makeinfo__.m Wed Mar 28 13:11:00 2018 -0700 @@ -18,7 +18,7 @@ ## -*- texinfo -*- ## @deftypefn {} {[@var{retval}, @var{status}] =} __makeinfo__ (@var{text}, @var{output_type}) -## @deftypefnx {} {[@var{retval}, @var{status}] =} __makeinfo__ (@var{text}, @var{output_type}, @var{see_also}) +## @deftypefnx {} {[@var{retval}, @var{status}] =} __makeinfo__ (@var{text}, @var{output_type}, @var{fsee_also}) ## Undocumented internal function. ## @end deftypefn @@ -34,11 +34,11 @@ ## macro is expanded, but otherwise the text is unaltered. ## ## If the optional argument @var{see_also} is present, it is used to expand the -## Octave specific @t{@@seealso} macro. This argument must be a function handle, -## that accepts a cell array of strings as input argument (each elements of the -## array corresponds to the arguments to the @t{@@seealso} macro), and return -## the expanded string. If this argument is not given, the @t{@@seealso} macro -## will be expanded to the text +## Octave specific @t{@@seealso} macro. This argument must be a function +## handle, that accepts a cell array of strings as input argument (each +## elements of the array corresponds to the arguments to the @t{@@seealso} +## macro), and return the expanded string. If this argument is not given, the +## @t{@@seealso} macro will be expanded to the text ## ## @example ## See also: arg1, arg2, ...
--- a/scripts/optimization/private/__fdjac__.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/optimization/private/__fdjac__.m Wed Mar 28 13:11:00 2018 -0700 @@ -17,7 +17,7 @@ ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {} __fdjac__ (@var{fcn}, @var{x}, @var{fvec}, @var{err}) +## @deftypefn {} {} __fdjac__ (@var{fcn}, @var{x}, @var{fvec}, @var{typicalx}, @var{cdif}, @var{err}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/plot/appearance/__getlegenddata__.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/plot/appearance/__getlegenddata__.m Wed Mar 28 13:11:00 2018 -0700 @@ -17,7 +17,7 @@ ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {[@var{hplots}, @var{strings}] =} __getlegenddata__ (@var{h}) +## @deftypefn {} {[@var{hplots}, @var{strings}] =} __getlegenddata__ (@var{hlegend}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/plot/appearance/private/__axis_label__.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/plot/appearance/private/__axis_label__.m Wed Mar 28 13:11:00 2018 -0700 @@ -17,7 +17,7 @@ ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {} __axis_label__ (@var{caller}, @var{h}, @var{txt}, @dots{}) +## @deftypefn {} {} __axis_label__ (@var{caller}, @var{hax}, @var{txt}, @dots{}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/plot/draw/private/__errplot__.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/plot/draw/private/__errplot__.m Wed Mar 28 13:11:00 2018 -0700 @@ -17,7 +17,7 @@ ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {@var{h} =} __errplot__ (@var{fstr}, @var{hax}, @dots{}) +## @deftypefn {} {@var{h} =} __errplot__ (@var{caller}, @var{hax}, @dots{}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/plot/draw/private/__interp_cube__.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/plot/draw/private/__interp_cube__.m Wed Mar 28 13:11:00 2018 -0700 @@ -19,7 +19,7 @@ ## Author: Martin Helm <martin@mhelm.de> ## -*- texinfo -*- -## @deftypefn {} {[@var{vxyz}, @var{idx}, @var{frac}] =} __interp_cube__ (@var{caller}, @var{x}, @var{y}, @var{z}, @var{val}, @var{v}) +## @deftypefn {} {[@var{vxyz}, @var{idx}, @var{frac}] =} __interp_cube__ (@var{caller}, @var{x}, @var{y}, @var{z}, @var{val}, @var{v}, @var{req}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/plot/util/__pltopt__.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/plot/util/__pltopt__.m Wed Mar 28 13:11:00 2018 -0700 @@ -17,11 +17,7 @@ ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {} __pltopt__ (@var{caller}, @var{opt}) -## Undocumented internal function. -## @end deftypefn - -## @deftypefn {} {} __pltopt__ (@var{caller}, @var{opt}) +## @deftypefn {} {} __pltopt__ (@var{caller}, @var{opt}, @var{err_on_invalid}) ## ## Decode plot option strings. ## @@ -86,6 +82,7 @@ ## ## The legend may be fixed to include the name of the variable ## plotted in some future version of Octave. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/util/private/__gnuplot_get_var__.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/plot/util/private/__gnuplot_get_var__.m Wed Mar 28 13:11:00 2018 -0700 @@ -17,7 +17,7 @@ ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {@var{value} =} __gnuplot_get_var__ (@var{h}, @var{name}, @var{fmt}) +## @deftypefn {} {@var{value} =} __gnuplot_get_var__ (@var{h}, @var{gp_var_name}, @var{fmt}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/plot/util/private/__gnuplot_has_terminal__.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/plot/util/private/__gnuplot_has_terminal__.m Wed Mar 28 13:11:00 2018 -0700 @@ -17,7 +17,8 @@ ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {@var{has_terminal} =} __gnuplot_has_terminal__ (@var{terminal}) +## @deftypefn {} {@var{has_terminal} =} __gnuplot_has_terminal__ (@var{term}) +## @deftypefnx {} {@var{has_terminal} =} __gnuplot_has_terminal__ (@var{term}, @var{plot_stream}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/strings/isstring.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/strings/isstring.m Wed Mar 28 13:11:00 2018 -0700 @@ -17,8 +17,8 @@ ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {} isstring (@var{x}) -## Return true if @var{x} is a string array. +## @deftypefn {} {} isstring (@var{s}) +## Return true if @var{s} is a string array. ## ## A string array is a data type that stores strings (row vectors of ## characters) at each element in the array. It is distinct from character
--- a/scripts/testfun/__run_test_suite__.m Wed Mar 28 12:22:34 2018 -0700 +++ b/scripts/testfun/__run_test_suite__.m Wed Mar 28 13:11:00 2018 -0700 @@ -17,7 +17,8 @@ ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {} __run_test_suite__ (@var{fcndirs}, @var{fixedtestdirs}) +## @deftypefn {} {} __run_test_suite__ (@var{fcndirs}, @var{fixedtestdirs}) +## @deftypefnx {} {} __run_test_suite__ (@var{fcndirs}, @var{fixedtestdirs}, @var{topsrcdir}, @var{topbuilddir}) ## Undocumented internal function. ## @end deftypefn