Mercurial > hg > octave-max
changeset 8812:7d48766c21a5
use consistent format for doc strings of internal functions
line wrap: on
line diff
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,27 @@ +2009-02-19 John W. Eaton <jwe@octave.org> + + * general/__isequal__.m, general/__splinen__.m, image/__img__.m, + image/__img_via_file__.m, miscellaneous/__xzip__.m, + optimization/__all_opts__.m, optimization/__dogleg__.m, + optimization/__fdjac__.m, path/__extractpath__.m, + plot/__add_datasource__.m, plot/__area__.m, + plot/__axes_limits__.m, plot/__axis_label__.m, plot/__bar__.m, + plot/__bars__.m, plot/__clabel__.m, plot/__contour__.m, + plot/__default_plot_options__.m, plot/__errcomm__.m, + plot/__errplot__.m, plot/__ezplot__.m, + plot/__gnuplot_has_feature__.m, plot/__gnuplot_version__.m, + plot/__go_close_all__.m, plot/__go_draw_axes__.m, + plot/__go_draw_figure__.m, plot/__line__.m, + plot/__next_line_color__.m, plot/__patch__.m, plot/__plr1__.m, + plot/__plr2__.m, plot/__plt1__.m, plot/__plt2__.m, + plot/__plt2mm__.m, plot/__plt2mv__.m, plot/__plt2ss__.m, + plot/__plt2sv__.m, plot/__plt2vm__.m, plot/__plt2vs__.m, + plot/__plt2vv__.m, plot/__plt__.m, plot/__plt_get_axis_arg__.m, + plot/__pltopt1__.m, plot/__pltopt__.m, plot/__quiver__.m, + plot/__scatter__.m, plot/__stem__.m, startup/__finish__.m, + statistics/base/__quantile__.m: Consistent doc strings for + internal fucntions. + 2009-02-18 Ben Abbott <bpabbott@mac.com> * plot/subplot.m: Fix unintended deletion of axes.
--- a/scripts/general/__isequal__.m +++ b/scripts/general/__isequal__.m @@ -20,12 +20,13 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} __isequal__ (@var{nans_compare_equal}, @var{x1}, @var{x2}, @dots{}) +## Undocumented internal function. +## @end deftypefn + ## Return true if @var{x1}, @var{x2}, @dots{} are all equal and ## @var{nans_compare_equal} evaluates to false. ## ## If @var{nans_compare_equal} evaluates to true, then assume NaN == NaN. -## @seealso{isequal, isequalwithequalnans} -## @end deftypefn ## Modified by: William Poetra Yoga Hadisoeseno
--- a/scripts/general/__splinen__.m +++ b/scripts/general/__splinen__.m @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{yi} =} __splinen__ (@var{x}, @var{y}, @var{xi}) -## Internal support function for multi-dimensional splines. +## Undocumented internal function. ## @end deftypefn ## FIXME: Allow arbitrary grids..
--- a/scripts/image/__img__.m +++ b/scripts/image/__img__.m @@ -19,14 +19,15 @@ ## Undocumented internal function. ## -*- texinfo -*- -## @deftypefn {Function File} {} __img__ (@var{img}) -## @deftypefnx {Function File} {} __img__ (@var{x}, @var{y}, @var{img}) +## @deftypefnx {Function File} {} __img__ (@var{x}, @var{y}, @var{img}, @dots{}) +## Undocumented internal function. +## @end deftypefn + ## Generic image creation. ## ## The axis values corresponding to the matrix elements are specified in ## @var{x} and @var{y}. If you're not using gnuplot 4.2 or later, these ## variables are ignored. -## @end deftypefn ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: July 1994
--- a/scripts/image/__img_via_file__.m +++ b/scripts/image/__img_via_file__.m @@ -19,7 +19,10 @@ ## Undocumented internal function. ## -*- texinfo -*- -## @deftypefn {Function File} {} __img_via_file__(@var{x}, @var{y}, @var{im}, @var{zoom}, @var{command}) +## @deftypefn {Function File} {} __img_via_file__ (@var{x}, @var{y}, @var{im}, @var{zoom}, @var{command}) +## Undocumented internal function. +## @end deftypefn + ## Display an image by saving it to a file in PPM format and launching ## @var{command}. ## @@ -27,8 +30,6 @@ ## possibly @code{%f}. The @code{%s} will be replaced by the filename ## of the image, and the @code{%f} will be replaced by @var{zoom}. The ## @var{x} and @var{y} arguments are ignored. -## @seealso{image, imshow, __img__, __img_via_file__, image_viewer} -## @end deftypefn function __img_via_file__ (x, y, im, zoom, command)
--- a/scripts/miscellaneous/__xzip__.m +++ b/scripts/miscellaneous/__xzip__.m @@ -18,16 +18,17 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{entries} =} _xzip_ (@var{commandname}, @var{extension}, @var{commandtemplate}, @var{files}, @var{outdir}) -## Compresses the list of files and/or directories specified in @var{files} +## @deftypefn {Function File} {@var{entries} =} __xzip__ (@var{commandname}, @var{extension}, @var{commandtemplate}, @var{files}, @var{outdir}) +## Undocumented internal function. +## @end deftypefn + +## Compress the list of files and/or directories specified in @var{files} ## with the external compression command @var{commandname}. The template ## @var{commandtemplate} is used to actually start the command. Each file ## is compressed separately and a new file with the extension @var{extension} ## is created and placed into the directory @var{outdir}. The original files ## are not touched. Existing compressed files are silently overwritten. ## This is an internal function. Do not use directly. -## @seealso{gzip, bzip2} -## @end deftypefn function entries = __xzip__ (commandname, extension, commandtemplate, files, outdir)
--- a/scripts/optimization/__all_opts__.m +++ b/scripts/optimization/__all_opts__.m @@ -17,11 +17,13 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} __all_opts__ () -## internal function. Queries all options from all known optimization -## functions and returns a list of possible values. +## @deftypefn {Function File} {@var{names} =} __all_opts__ (@dots{}) +## Undocumented internal function. ## @end deftypefn +## Query all options from all known optimization functions and return a +## list of possible values. + function names = __all_opts__ (varargin) persistent saved_names = {};
--- a/scripts/optimization/__dogleg__.m +++ b/scripts/optimization/__dogleg__.m @@ -18,10 +18,12 @@ ## -*- texinfo -*- ## @deftypefn{Function File} {@var{x}} = __dogleg__ (@var{r}, @var{b}, @var{x}, @var{d}, @var{delta}) -## Solves the double dogleg trust-region problem: +## Undocumented internal function. +## @end deftypefn + +## Solve the double dogleg trust-region problem: ## Minimize norm(r*x-b) subject to the constraint norm(d.*x) <= delta, ## x being a convex combination of the gauss-newton and scaled gradient. -## @end deftypefn ## TODO: error checks ## TODO: handle singularity, or leave it up to mldivide?
--- a/scripts/optimization/__fdjac__.m +++ b/scripts/optimization/__fdjac__.m @@ -18,6 +18,7 @@ ## -*- texinfo -*- ## @deftypefn{Function File} {[@var{fval}, @var{fjac}]} = __fdjac__ (@var{fcn}, @var{x}, @var{err}) +## Undocumented internal function. ## @end deftypefn function [fvec, fjac] = __fdjac__ (fcn, x, err = 0)
--- a/scripts/path/__extractpath__.m +++ b/scripts/path/__extractpath__.m @@ -19,12 +19,13 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{val} =} __extractpath__ (@var{file}) +## Undocumented internal function. +## @end deftypefn + ## Extact the path information from the script/function @var{file}, ## created by @file{savepath.m}. If @var{file} is omitted, ## @file{~/.octaverc} is used. If successful, @code{__extractpath__} ## returns the path specified in @var{file}. -## @seealso{path, addpath, rmpath, genpath, pathdef, savepath, pathsep} -## @end deftypefn ## Author: Ben Abbott <bpabbott@mac.com>
--- a/scripts/plot/__add_datasource__.m +++ b/scripts/plot/__add_datasource__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. -## Undocumented internal function +## -*- texinfo -*- +## @deftypefn {Function File} {@var{newargs} =} __add_datasource__ (@var{fcn}, @var{h}, @var{data}, @var{varargin}) +## Undocumented internal function. +## @end deftypefn function newargs = __add_datasource__ (fcn, h, data, varargin)
--- a/scripts/plot/__area__.m +++ b/scripts/plot/__area__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __area__ (@var{ax}, @var{x}, @var{y}, @var{bv}, @dots{}) ## Undocumented internal function. +## @end deftypefn function retval = __area__ (ax, x, y, bv, varargin)
--- a/scripts/plot/__axes_limits__.m +++ b/scripts/plot/__axes_limits__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __axes_limits__ (@var{fcn}, @dots{}) ## Undocumented internal function. +## @end deftypefn function retval = __axes_limits__ (fcn, varargin)
--- a/scripts/plot/__axis_label__.m +++ b/scripts/plot/__axis_label__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __axis_label__ (@var{caller}, @var{txt}, @dots{}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__bar__.m +++ b/scripts/plot/__bar__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __bar__ (@var{vertical}, @var{func}, @dots{}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__bars__.m +++ b/scripts/plot/__bars__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __bars__ (@var{ax}, @var{vertical}, @var{x}, @var{y}, @var{xb}, @var{yb}, @var{width}, @var{group}, @var{have_color_spec}, @var{base_value}, @dots{}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__clabel__.m +++ b/scripts/plot/__clabel__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {@var{h} =} __clabel__ (@var{c}, @var{v}, @var{hparent}, @var{label_spacing}, @var{z}, @var{varargin}) ## Undocumented internal function. +## @end deftypefn function h = __clabel__ (c, v, hparent, label_spacing, z, varargin) ## FIXME
--- a/scripts/plot/__contour__.m +++ b/scripts/plot/__contour__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {[@var{c}, @var{hg}] =} __contour__ (@dots{}) ## Undocumented internal function. +## @end deftypefn function [c, hg] = __contour__ (varargin) ax = varargin{1};
--- a/scripts/plot/__default_plot_options__.m +++ b/scripts/plot/__default_plot_options__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {@var{options} =} __default_plot_options__ () ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__errcomm__.m +++ b/scripts/plot/__errcomm__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __errcomm__ (@var{caller}, @var{p}, @dots{}) ## Undocumented internal function. +## @end deftypefn ## Created: 20.02.2001 ## Author: Teemu Ikonen <tpikonen@pcu.helsinki.fi>
--- a/scripts/plot/__errplot__.m +++ b/scripts/plot/__errplot__.m @@ -17,7 +17,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {@var{h} =} __errplot__ (@var{fstr}, @var{p}, @dots{}) ## Undocumented internal function. +## @end deftypefn ## Created: 18.7.2000 ## Author: Teemu Ikonen <tpikonen@pcu.helsinki.fi>
--- a/scripts/plot/__ezplot__.m +++ b/scripts/plot/__ezplot__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. -## Undocumented internal function +## -*- texinfo -*- +## @deftypefn {Function File} {[@var{h}, @var{needusage}] =} __ezplot__ (@var{pfunc}, @var{varargin}) +## Undocumented internal function. +## @end deftypefn function [h, needusage] = __ezplot__ (pfunc, varargin)
--- a/scripts/plot/__gnuplot_has_feature__.m +++ b/scripts/plot/__gnuplot_has_feature__.m @@ -15,7 +15,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{has_feature} = } __gnuplot_has_feature__ (@var{feature}) +## @deftypefn {Function File} {@var{has_feature} =} __gnuplot_has_feature__ (@var{feature}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/plot/__gnuplot_version__.m +++ b/scripts/plot/__gnuplot_version__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {@var{version} =} __gnuplot_version__ () ## Undocumented internal function. +## @end deftypefn ## Return the version of gnuplot we are using. Note that we do not ## attempt to handle the case of the user switching to different
--- a/scripts/plot/__go_close_all__.m +++ b/scripts/plot/__go_close_all__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __go_close_all__ () ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__go_draw_axes__.m +++ b/scripts/plot/__go_draw_axes__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __go_draw_axes__ (@var{h}, @var{plot_stream}, @var{enhanced}, @var{mono}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__go_draw_figure__.m +++ b/scripts/plot/__go_draw_figure__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __go_draw_figure__ (@var{h}, @var{plot_stream}, @var{enhanced}, @var{mono}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__line__.m +++ b/scripts/plot/__line__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {@var{h} =} __line__ (@var{p}, @dots{}) ## Undocumented internal function. +## @end deftypefn ## __line__ (p, x, y, z) ## Create line object from x, y, and z with parent p.
--- a/scripts/plot/__next_line_color__.m +++ b/scripts/plot/__next_line_color__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {@var{rgb} =} __next_line_color__ (@var{reset}) ## Undocumented internal function. +## @end deftypefn ## Return the next line color in the rotation.
--- a/scripts/plot/__patch__.m +++ b/scripts/plot/__patch__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {[@var{h}, @var{fail}] =} __patch__ (@var{p}, @dots{}) ## Undocumented internal function. +## @end deftypefn ## __patch__ (p, x, y, c) ## Create patch object from x and y with color c and parent p.
--- a/scripts/plot/__plr1__.m +++ b/scripts/plot/__plr1__.m @@ -17,7 +17,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __plr1__ (@var{h}, @var{theta}, @var{fmt}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plr2__.m +++ b/scripts/plot/__plr2__.m @@ -17,7 +17,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __plr2__ (@var{h}, @var{theta}, @var{rho}, @var{fmt}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt1__.m +++ b/scripts/plot/__plt1__.m @@ -17,7 +17,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt1__ (@var{h}, @var{x1}, @var{options}, @var{properties}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt2__.m +++ b/scripts/plot/__plt2__.m @@ -17,7 +17,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt2__ (@var{h}, @var{x1}, @var{x2}, @var{options}, @var{properties}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt2mm__.m +++ b/scripts/plot/__plt2mm__.m @@ -17,7 +17,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt2mm__ (@var{h}, @var{x}, @var{y}, @var{options}, @var{properties}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt2mv__.m +++ b/scripts/plot/__plt2mv__.m @@ -17,7 +17,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt2mv__ (@var{h}, @var{x}, @var{y}, @var{options}, @var{properties}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt2ss__.m +++ b/scripts/plot/__plt2ss__.m @@ -17,7 +17,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt2ss__ (@var{h}, @var{x}, @var{y}, @var{options}, @var{properties}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt2sv__.m +++ b/scripts/plot/__plt2sv__.m @@ -17,7 +17,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt2sv__ (@var{h}, @var{x}, @var{y}, @var{options}, @var{properties}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt2vm__.m +++ b/scripts/plot/__plt2vm__.m @@ -17,7 +17,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt2vm__ (@var{h}, @var{x}, @var{y}, @var{options}, @var{properties}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt2vs__.m +++ b/scripts/plot/__plt2vs__.m @@ -17,7 +17,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt2vs__ (@var{h}, @var{x}, @var{y}, @var{options}, @var{properties}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt2vv__.m +++ b/scripts/plot/__plt2vv__.m @@ -17,7 +17,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt2vv__ (@var{h}, @var{x}, @var{y}, @var{options}, @var{properties}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt__.m +++ b/scripts/plot/__plt__.m @@ -17,7 +17,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt__ (@var{caller}, @var{h}, @var{varargin}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt_get_axis_arg__.m +++ b/scripts/plot/__plt_get_axis_arg__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {[@var{h}, @var{varargin}, @var{narg}] =} __plt_get_axis_arg__ (@var{caller}, @var{varargin}) ## Undocumented internal function. +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__pltopt1__.m +++ b/scripts/plot/__pltopt1__.m @@ -17,7 +17,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {[@var{options}, @var{valid}] =} __pltopt1__ (@var{caller}, @var{opt}, @var{err_on_invalid}) ## Undocumented internal function. +## @end deftypefn ## Really decode plot option strings.
--- a/scripts/plot/__pltopt__.m +++ b/scripts/plot/__pltopt__.m @@ -17,7 +17,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {} __pltopt__ (@var{caller}, @var{opt}) ## Undocumented internal function. +## @end deftypefn ## @deftypefn {Function File} {} __pltopt__ (@var{caller}, @var{opt}) ##
--- a/scripts/plot/__quiver__.m +++ b/scripts/plot/__quiver__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. -## Undocumented internal function +## -*- texinfo -*- +## @deftypefn {Function File} {@var{hg} =} __quiver__ (@dots{}) +## Undocumented internal function. +## @end deftypefn function hg = __quiver__ (varargin)
--- a/scripts/plot/__scatter__.m +++ b/scripts/plot/__scatter__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {@var{hg} =} __scatter__ (@dots{}) ## Undocumented internal function. +## @end deftypefn function hg = __scatter__ (varargin)
--- a/scripts/plot/__stem__.m +++ b/scripts/plot/__stem__.m @@ -16,7 +16,10 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. -## Undocumented internal function +## -*- texinfo -*- +## @deftypefn {Function File} {@var{h} =} __stem__ (@var{have_z}, @var{varargin}) +## Undocumented internal function. +## @end deftypefn ## Author: Michel D. Schmid <michaelschmid@users.sourceforge.net> ## Adapted-by: jwe
--- a/scripts/startup/__finish__.m +++ b/scripts/startup/__finish__.m @@ -18,16 +18,15 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} __finish__ () -## Checks for the existence of the function/script, @file{finish}, in the -## path or current working directory and executes it. This function is -## intended to be excecuted upon a clean exit form Octave. -## -## This functin is intended to be called upon a clean exit from Octave. -## This is accomplished in the system script @file{startup/octaverc} by -## use of the built in function @code{onexit}. -## @seealso{octaverc, onexit} +## Undocumented internal function. ## @end deftypefn +## Check for the existence of the function/script, @file{finish}, in the +## path or current working directory and execute it. This function is +## intended to be excecuted upon a clean exit form Octave. This is +## accomplished in the system script @file{startup/octaverc} by use of +## the built-in function @code{onexit}. + function __finish__ () if (exist ("finish", "file"))
--- a/scripts/statistics/base/__quantile__.m +++ b/scripts/statistics/base/__quantile__.m @@ -19,6 +19,9 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{q} =} __quantile__ (@var{x}, @var{p}) ## @deftypefnx {Function File} {@var{q} =} __quantile__ (@var{x}, @var{p}, @var{method}) +## Undocumented internal function. +## @end deftypefn + ## For the cumulative probability values in @var{p}, compute the ## quantiles, @var{q} (the inverse of the cdf), for the sample, @var{x}. ## @@ -26,7 +29,6 @@ ## (http://www.r-project.org/). The default is @var{method} = 7. For more ## detail, see `help quantile'. ## @seealso{prctile, quantile, statistics} -## @end deftypefn ## Author: Ben Abbott <bpabbott@mac.com> ## Vectorized version: Jaroslav Hajek <highegg@gmail.com>
--- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,8 @@ +2009-02-19 John W. Eaton <jwe@octave.org> + + * data.cc, graphics.cc, help.cc, lex.l, load-path.cc, parse.y: + Consistent doc strings for internal functions. + 2009-02-18 John W. Eaton <jwe@octave.org> * ov.cc (convert_to_octave_idx_type_array): New static function.
--- a/src/data.cc +++ b/src/data.cc @@ -5624,14 +5624,16 @@ */ +// Sort the rows of the matrix @var{a} according to the order +// specified by @var{mode}, which can either be `ascend' or `descend' +// and return the index vector corresponding to the sort order. +// +// This function does not yet support sparse matrices. + DEFUN (__sort_rows_idx__, args, , "-*- texinfo -*-\n\ @deftypefn {Function File} {} __sort_rows_idx__ (@var{a}, @var{mode})\n\ -Sort the rows of the matrix @var{a} according to the order specified\n\ -by @var{mode}, which can either be `ascend' or `descend'.\n\ -Returns the index vector.\n\ -\n\ -This function does not yet support sparse matrices.\n\ +Undocumented internal function.\n\ @end deftypefn\n") { octave_value retval;
--- a/src/graphics.cc +++ b/src/graphics.cc @@ -4452,12 +4452,14 @@ return retval; } +// Return all properties from the graphics handle @var{h}. +// If @var{h} is a vector, return a cell array including the +// property values or lists respectively. + DEFUN (__get__, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} __get__ (@var{h})\n\ -Return all properties from the graphics handle @var{h}.\n\ -If @var{h} is a vector, return a cell array including the property\n\ -values or lists respectively.\n\ +Undocumented internal function.\n\ @end deftypefn") { gh_manager::autolock guard;
--- a/src/help.cc +++ b/src/help.cc @@ -735,7 +735,7 @@ To convert the help text to other formats, use the @code{makeinfo} function.\n\ \n\ @seealso{makeinfo}\n\ -@end deftypefn\n") +@end deftypefn") { octave_value_list retval; @@ -762,32 +762,38 @@ return retval; } -DEFUN (__operators__, , , "-*- texinfo -*-\n\ +// Return a cell array of strings containing the names of all +// operators. + +DEFUN (__operators__, , , + "-*- texinfo -*-\n\ @deftypefn {Function File} __operators__ ()\n\ -Return a cell array of strings containing the names of all operators.\n\ -\n\ -This is an internal function and should not be used directly.\n\ -@end deftypefn\n") +Undocumented internal function.\n\ +@end deftypefn") { return octave_value (Cell (names (operators_map))); } -DEFUN (__keywords__, , , "-*- texinfo -*-\n\ +// Return a cell array of strings containing the names of all +// keywords. + +DEFUN (__keywords__, , , + "-*- texinfo -*-\n\ @deftypefn {Function File} __keywords__ ()\n\ -Return a cell array of strings containing the names of all keywords.\n\ -\n\ -This is an internal function and should not be used directly.\n\ -@end deftypefn\n") +Undocumented internal function.\n\ +@end deftypefn") { return octave_value (Cell (names (keywords_map))); } -DEFUN (__builtins__, , , "-*- texinfo -*-\n\ +// Return a cell array of strings containing the names of all builtin +// functions. + +DEFUN (__builtins__, , , + "-*- texinfo -*-\n\ @deftypefn {Function File} __builtins__ ()\n\ -Return a cell array of strings containing the names of all builtin functions.\n\ -\n\ -This is an internal function and should not be used directly.\n\ -@end deftypefn\n") +Undocumented internal function.\n\ +@end deftypefn") { const string_vector bif = symbol_table::built_in_function_names (); @@ -914,18 +920,16 @@ return false; } -DEFUN (__list_functions__, args, , "-*- texinfo -*-\n\ +// Return a cell array of strings containing the names of all +// functions available in DIRECTORY. If no directory is given, search +// the current path. + +DEFUN (__list_functions__, args, , + "-*- texinfo -*-\n\ @deftypefn {Function File} {@var{retval} =} __list_functions__ ()\n\ @deftypefnx{Function File} {@var{retval} =} __list_functions__ (@var{directory})\n\ -Return the functions available in a given directory.\n\ -\n\ -The function returns a cell array of strings containing the names of all\n\ -functions available in said directory. If no directory is given, the current\n\ -path is searched.\n\ -\n\ -This is an internal function and should not be used directly.\n\ -@seealso{path}\n\ -@end deftypefn\n") +Undocumented internal function.\n\ +@end deftypefn") { octave_value_list retval;
--- a/src/lex.l +++ b/src/lex.l @@ -3557,7 +3557,7 @@ DEFUN (__display_tokens__, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} __display_tokens__\n\ +@deftypefn {Built-in Function} {} __display_tokens__ ()\n\ Query or set the internal variable that determines whether Octave's\n\ lexer displays tokens as they are read.\n\ @end deftypefn") @@ -3567,7 +3567,7 @@ DEFUN (__token_count__, , , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} __token_count__\n\ +@deftypefn {Built-in Function} {} __token_count__ ()\n\ Number of language tokens processed since Octave startup.\n\ @end deftypefn") { @@ -3575,7 +3575,10 @@ } DEFUN (__lexer_debug_flag__, args, nargout, - "Undocumented internal function.") + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {@var{old_val} =} __lexer_debug_flag__ (@var{new_val}))\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval;
--- a/src/load-path.cc +++ b/src/load-path.cc @@ -1830,14 +1830,15 @@ return octave_value (load_path::system_path ()); } +// Return Octave's original default list of directories in which to +// search for function files. This corresponds to the path that +// exists prior to running the system's octaverc file or the user's +// ~/.octaverc file + DEFUN (__pathorig__, , , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{val} =} __pathorig__ ()\n\ -Return Octave's original default list of directories in which to search\n\ -for function files. This corresponds to the path that exists prior to\n\ -running the system's @file{octaverc}, or the users' @file{~/.octaverc}\n\ -@seealso{path, addpath, rmpath, genpath, savepath, pathsep, \n\ -restoredefaultpath}\n\ +Undocumented internal function.\n\ @end deftypefn") { return octave_value (load_path::system_path ());
--- a/src/parse.y +++ b/src/parse.y @@ -4207,7 +4207,10 @@ } DEFUN (__parser_debug_flag__, args, nargout, - "Undocumented internal function.") + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {@var{old_val} =} __parser_debug_flag__ (@var{new_val}))\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval;