# HG changeset patch # User Rik # Date 1431237009 25200 # Node ID 777f26aa8e3e428922afe9487bead2c4b4b8f8c9 # Parent 4f45eaf839089b0ef9eec9645aba9d4a876152f3 doc: Update more docstrings to have one sentence summary as first line. Reviewed plot/ and gui/ in scripts directory. * scripts/gui/errordlg.m, scripts/gui/helpdlg.m, scripts/gui/inputdlg.m, scripts/gui/listdlg.m, scripts/gui/msgbox.m, scripts/gui/private/__get_funcname__.m, scripts/gui/private/__uiobject_split_args__.m, scripts/gui/questdlg.m, scripts/gui/uigetdir.m, scripts/gui/uigetfile.m, scripts/gui/uiwait.m, scripts/gui/waitbar.m, scripts/gui/warndlg.m, scripts/plot/appearance/annotation.m, scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m, scripts/plot/appearance/caxis.m, scripts/plot/appearance/datetick.m, scripts/plot/appearance/hidden.m, scripts/plot/appearance/legend.m, scripts/plot/appearance/xlim.m, scripts/plot/appearance/ylim.m, scripts/plot/appearance/zlim.m, scripts/plot/draw/area.m, scripts/plot/draw/comet.m, scripts/plot/draw/comet3.m, scripts/plot/draw/contour.m, scripts/plot/draw/contourf.m, scripts/plot/draw/isocolors.m, scripts/plot/draw/isonormals.m, scripts/plot/draw/isosurface.m, scripts/plot/draw/plotmatrix.m, scripts/plot/draw/quiver.m, scripts/plot/draw/quiver3.m, scripts/plot/draw/ribbon.m, scripts/plot/draw/semilogxerr.m, scripts/plot/draw/semilogyerr.m, scripts/plot/draw/sphere.m, scripts/plot/draw/surfl.m, scripts/plot/draw/tetramesh.m, scripts/plot/util/allchild.m, scripts/plot/util/ancestor.m, scripts/plot/util/axes.m, scripts/plot/util/colstyle.m, scripts/plot/util/frame2im.m, scripts/plot/util/gnuplot_binary.in, scripts/plot/util/hgsave.m, scripts/plot/util/im2frame.m, scripts/plot/util/isaxes.m, scripts/plot/util/isfigure.m, scripts/plot/util/linkaxes.m, scripts/plot/util/ndgrid.m, scripts/plot/util/pan.m, scripts/plot/util/print.m, scripts/plot/util/printd.m, scripts/plot/util/private/__add_default_menu__.m, scripts/plot/util/rotate.m, scripts/plot/util/rotate3d.m, scripts/plot/util/saveas.m, scripts/plot/util/struct2hdl.m, scripts/plot/util/subplot.m, scripts/plot/util/zoom.m: Update more docstrings to have one sentence summary as first line. diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/gui/errordlg.m --- a/scripts/gui/errordlg.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/gui/errordlg.m Sat May 09 22:50:09 2015 -0700 @@ -22,10 +22,11 @@ ## @deftypefnx {Function File} {@var{h} =} errordlg (@var{msg}, @var{title}, @var{createmode}) ## Display @var{msg} using an error dialog box. ## -## The message may have multiple lines separated by newline characters -## ("\n"), or it may be a cellstr array with one element for each -## line. The optional input @var{title} (character string) can be used to -## set the dialog caption. The default title is @qcode{"Error Dialog"}. +## The message may have multiple lines separated by newline characters ("\n"), +## or it may be a cellstr array with one element for each line. +## +## The optional input @var{title} (character string) can be used to set the +## dialog caption. The default title is @qcode{"Error Dialog"}. ## ## The return value is always 1. ## diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/gui/helpdlg.m --- a/scripts/gui/helpdlg.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/gui/helpdlg.m Sat May 09 22:50:09 2015 -0700 @@ -23,7 +23,9 @@ ## ## The message may have multiple lines separated by newline characters ## ("\n"), or it may be a cellstr array with one element for each -## line. The optional input @var{title} (character string) can be used to +## line. +## +## The optional input @var{title} (character string) can be used to ## set the dialog caption. The default title is @qcode{"Help Dialog"}. ## ## The return value is always 1. diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/gui/inputdlg.m --- a/scripts/gui/inputdlg.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/gui/inputdlg.m Sat May 09 22:50:09 2015 -0700 @@ -21,9 +21,9 @@ ## @deftypefnx {Function File} {@var{cstr} =} inputdlg (@var{prompt}, @var{title}) ## @deftypefnx {Function File} {@var{cstr} =} inputdlg (@var{prompt}, @var{title}, @var{rowscols}) ## @deftypefnx {Function File} {@var{cstr} =} inputdlg (@var{prompt}, @var{title}, @var{rowscols}, @var{defaults}) -## Return user input from a multi-textfield dialog box in a cell array -## of strings, or an empty cell array if the dialog is closed by the -## Cancel button. +## Return user input from a multi-textfield dialog box in a cell array of +## strings, or an empty cell array if the dialog is closed by the Cancel +## button. ## ## Inputs: ## @@ -32,28 +32,23 @@ ## A cell array with strings labeling each text field. This input is required. ## ## @item title -## String to use for the caption of the dialog. The default is @qcode{"Input -## Dialog"}. +## String to use for the caption of the dialog. The default is +## @qcode{"Input Dialog"}. ## ## @item rowscols ## Specifies the size of the text fields and can take three forms: ## ## @enumerate -## @item a scalar value which defines the number of rows used for each -## text field. +## @item a scalar value which defines the number of rows used for each text field. ## -## @item a vector which defines the individual number of rows -## used for each text field. +## @item a vector which defines the individual number of rows used for each text field. ## -## @item a matrix which defines the individual number of rows and -## columns used for each text field. In the matrix each row describes -## a single text field. The first column specifies the number of input -## rows to use and the second column specifies the text field width. +## @item a matrix which defines the individual number of rows and columns used for each text field. In the matrix each row describes a single text field. The first column specifies the number of input rows to use and the second column specifies the text field width. ## @end enumerate ## ## @item defaults -## A list of default values to place in each text fields. It must be -## a cell array of strings with the same size as @var{prompt}. +## A list of default values to place in each text fields. It must be a cell +## array of strings with the same size as @var{prompt}. ## @end table ## @seealso{errordlg, helpdlg, listdlg, msgbox, questdlg, warndlg} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/gui/listdlg.m --- a/scripts/gui/listdlg.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/gui/listdlg.m Sat May 09 22:50:09 2015 -0700 @@ -18,11 +18,12 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{sel}, @var{ok}] =} listdlg (@var{key}, @var{value}, @dots{}) -## Return user inputs from a list dialog box in a vector of -## selection indices @var{sel} and a flag @var{ok} indicating how the -## user closed the dialog box. The value of @var{ok} is 1 if the user -## closed the box with the OK button, otherwise it is 0 and @var{sel} is -## empty. +## Return user inputs from a list dialog box in a vector of selection indices +## @var{sel} and a flag @var{ok} indicating how the user closed the dialog +## box. +## +## The value of @var{ok} is 1 if the user closed the box with the OK button, +## otherwise it is 0 and @var{sel} is empty. ## ## The indices in @var{sel} are 1-based. ## @@ -39,19 +40,19 @@ ## can be either @qcode{"Single"} or @qcode{"Multiple"} (default). ## ## @item @qcode{"ListSize"} -## a vector with two elements @var{width} and @var{height} defining -## the size of the list field in pixels. Default is [160 300]. +## a vector with two elements @var{width} and @var{height} defining the size +## of the list field in pixels. Default is [160 300]. ## ## @item @qcode{"InitialValue"} -## a vector containing 1-based indices of preselected elements. Default -## is 1 (first item). +## a vector containing 1-based indices of preselected elements. +## Default is 1 (first item). ## ## @item @qcode{"Name"} ## a string to be used as the dialog caption. Default is "". ## ## @item @qcode{"PromptString"} -## a cell array of strings to be displayed above the list field. Default -## is @{@}. +## a cell array of strings to be displayed above the list field. +## Default is @{@}. ## ## @item @qcode{"OKString"} ## a string used to label the OK button. Default is @qcode{"OK"}. diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/gui/msgbox.m --- a/scripts/gui/msgbox.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/gui/msgbox.m Sat May 09 22:50:09 2015 -0700 @@ -23,20 +23,21 @@ ## @deftypefnx {Function File} {@var{h} =} msgbox (@dots{}, @var{createmode}) ## Display @var{msg} using a message dialog box. ## -## The message may have multiple lines separated by newline characters -## ("\n"), or it may be a cellstr array with one element for each -## line. The optional input @var{title} (character string) can be used to -## decorate the dialog caption. +## The message may have multiple lines separated by newline characters ("\n"), +## or it may be a cellstr array with one element for each line. +## +## The optional input @var{title} (character string) can be used to decorate +## the dialog caption. ## ## The optional argument @var{icon} selects a dialog icon. -## It can be one of @qcode{"none"} (default), @qcode{"error"}, -## @qcode{"help"}, or @qcode{"warn"}. +## It can be one of @qcode{"none"} (default), @qcode{"error"}, @qcode{"help"}, +## or @qcode{"warn"}. ## ## The return value is always 1. ## ## Compatibility Note: The optional argument @var{createmode} is accepted for ## @sc{matlab} compatibility, but is not implemented. -# +## ## @seealso{errordlg, helpdlg, inputdlg, listdlg, questdlg, warndlg} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/gui/private/__get_funcname__.m --- a/scripts/gui/private/__get_funcname__.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/gui/private/__get_funcname__.m Sat May 09 22:50:09 2015 -0700 @@ -20,7 +20,7 @@ ## @deftypefn {Function File} {@var{funcname} =} __get_funcname__ (@var{basename}) ## Internal function. ## -## Build function name for the current graphics toolkit according to schema +## Build function name for the current graphics toolkit according to the schema ## __[basename]_[graphics_toolkit]__, use fltk as default. ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/gui/private/__uiobject_split_args__.m --- a/scripts/gui/private/__uiobject_split_args__.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/gui/private/__uiobject_split_args__.m Sat May 09 22:50:09 2015 -0700 @@ -18,6 +18,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{p}, @var{args}] =} __uiobject_split_args__ (@var{who}, @var{args}, @var{parent_type}, @var{use_gcf}) +## Undocumented internal function. ## @end deftypefn ## Author: goffioul diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/gui/questdlg.m --- a/scripts/gui/questdlg.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/gui/questdlg.m Sat May 09 22:50:09 2015 -0700 @@ -22,27 +22,26 @@ ## @deftypefnx {Function File} {@var{btn} =} questdlg (@var{msg}, @var{title}, @var{default}) ## @deftypefnx {Function File} {@var{btn} =} questdlg (@var{msg}, @var{title}, @var{btn1}, @var{btn2}, @var{default}) ## @deftypefnx {Function File} {@var{btn} =} questdlg (@var{msg}, @var{title}, @var{btn1}, @var{btn2}, @var{btn3}, @var{default}) -## Display @var{msg} using a question dialog box and return the caption -## of the activated button. +## Display @var{msg} using a question dialog box and return the caption of +## the activated button. ## ## The dialog may contain two or three buttons which will all close the dialog. ## -## The message may have multiple lines separated by newline characters -## ("\n"), or it may be a cellstr array with one element for each -## line. The optional @var{title} (character string) can be used to -## decorate the dialog caption. +## The message may have multiple lines separated by newline characters ("\n"), +## or it may be a cellstr array with one element for each line. +## +## The optional @var{title} (character string) can be used to decorate the +## dialog caption. ## -## The string @var{default} identifies the default button, -## which is activated by pressing the @key{ENTER} key. -## It must match one of the strings given in @var{btn1}, @var{btn2}, or -## @var{btn3}. +## The string @var{default} identifies the default button, which is activated +## by pressing the @key{ENTER} key. It must match one of the strings given +## in @var{btn1}, @var{btn2}, or @var{btn3}. ## -## If only @var{msg} and @var{title} are specified, three buttons with -## the default captions @qcode{"Yes"}, @qcode{"No"}, and @qcode{"Cancel"} are -## used. +## If only @var{msg} and @var{title} are specified, three buttons with the +## default captions @qcode{"Yes"}, @qcode{"No"}, and @qcode{"Cancel"} are used. ## -## If only two button captions, @var{btn1} and @var{btn2}, are specified -## the dialog will have only these two buttons. +## If only two button captions, @var{btn1} and @var{btn2}, are specified the +## dialog will have only these two buttons. ## ## @seealso{errordlg, helpdlg, inputdlg, listdlg, warndlg} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/gui/uigetdir.m --- a/scripts/gui/uigetdir.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/gui/uigetdir.m Sat May 09 22:50:09 2015 -0700 @@ -23,6 +23,7 @@ ## Open a GUI dialog for selecting a directory. ## ## If @var{init_path} is not given the current working directory is used. +## ## @var{dialog_name} may be used to customize the dialog title. ## @seealso{uigetfile, uiputfile} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/gui/uigetfile.m --- a/scripts/gui/uigetfile.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/gui/uigetfile.m Sat May 09 22:50:09 2015 -0700 @@ -40,8 +40,8 @@ ## Example: @code{uigetfile ("*.ext")} ## ## @item A 2-column cell array -## containing a file extension in the first column and a brief description -## in the second column. +## containing a file extension in the first column and a brief description in +## the second column. ## Example: @code{uigetfile (@{"*.ext", "My Description";"*.xyz", ## "XYZ-Format"@})} ## @@ -52,6 +52,7 @@ ## @end table ## ## @var{dialog_name} can be used to customize the dialog title. +## ## If @var{default_file} is given then it will be selected in the GUI dialog. ## If, in addition, a path is given it is also used as current path. ## diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/gui/uiwait.m --- a/scripts/gui/uiwait.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/gui/uiwait.m Sat May 09 22:50:09 2015 -0700 @@ -20,8 +20,8 @@ ## @deftypefn {Function File} {} uiwait ## @deftypefnx {Function File} {} uiwait (@var{h}) ## @deftypefnx {Function File} {} uiwait (@var{h}, @var{timeout}) -## Suspend program execution until the figure with handle @var{h} is -## deleted or @code{uiresume} is called. +## Suspend program execution until the figure with handle @var{h} is deleted +## or @code{uiresume} is called. ## ## When no figure handle is specified this function uses the current figure. ## If the figure handle is invalid or there is no current figure, this diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/gui/waitbar.m --- a/scripts/gui/waitbar.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/gui/waitbar.m Sat May 09 22:50:09 2015 -0700 @@ -26,9 +26,12 @@ ## Return a handle @var{h} to a new waitbar object. ## ## The waitbar is filled to fraction @var{frac} which must be in the range -## [0, 1]. The optional message @var{msg} is centered and displayed above the -## waitbar. The appearance of the waitbar figure window can be configured by -## passing property/value pairs to the function. +## [0, 1]. +## +## The optional message @var{msg} is centered and displayed above the waitbar. +## +## The appearance of the waitbar figure window can be configured by passing +## property/value pairs to the function. ## ## When called with a single input the current waitbar, if it exists, is ## updated to the new value @var{frac}. If there are multiple outstanding diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/gui/warndlg.m --- a/scripts/gui/warndlg.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/gui/warndlg.m Sat May 09 22:50:09 2015 -0700 @@ -22,10 +22,11 @@ ## @deftypefnx {Function File} {@var{h} =} warndlg (@var{msg}, @var{title}, @var{createmode}) ## Display @var{msg} using a warning dialog box. ## -## The message may have multiple lines separated by newline characters -## ("\n"), or it may be a cellstr array with one element for each -## line. The optional input @var{title} (character string) can be used to -## set the dialog caption. The default title is @qcode{"Warning Dialog"}. +## The message may have multiple lines separated by newline characters ("\n"), +## or it may be a cellstr array with one element for each line. +## +## The optional input @var{title} (character string) can be used to set the +## dialog caption. The default title is @qcode{"Warning Dialog"}. ## ## The return value is always 1. ## diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/appearance/annotation.m --- a/scripts/plot/appearance/annotation.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/appearance/annotation.m Sat May 09 22:50:09 2015 -0700 @@ -145,7 +145,7 @@ ## See @qcode{"rectangle"} annotations for customization. ## @end table ## -## @seealso{xlabel, title} +## @seealso{xlabel, title, legend, colorbar} ## @end deftypefn function varargout = annotation (varargin) diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/appearance/axis.m --- a/scripts/plot/appearance/axis.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/appearance/axis.m Sat May 09 22:50:09 2015 -0700 @@ -39,9 +39,8 @@ ## With one output argument, @code{@var{limits} = axis} returns the current ## axis limits. ## -## The vector argument specifying limits is optional, and additional -## string arguments may be used to specify various axis properties. For -## example, +## The vector argument specifying limits is optional, and additional string +## arguments may be used to specify various axis properties. For example, ## ## @example ## axis ([1, 2, 3, 4], "square"); @@ -55,8 +54,7 @@ ## @end example ## ## @noindent -## turns tic marks on for all axes and tic mark labels on for the y-axis -## only. +## turns tic marks on for all axes and tic mark labels on for the y-axis only. ## ## @noindent ## The following options control the aspect ratio of the axes. @@ -77,8 +75,8 @@ ## ## @table @asis ## @item @qcode{"auto"} -## Set the specified axes to have nice limits around the data -## or all if no axes are specified. +## Set the specified axes to have nice limits around the data or all if no +## axes are specified. ## ## @item @qcode{"manual"} ## Fix the current axes limits. @@ -101,12 +99,12 @@ ## Turn tic marks off for all axes. ## ## @item @qcode{"tic[xyz]"} -## Turn tic marks on for all axes, or turn them on for the -## specified axes and off for the remainder. +## Turn tic marks on for all axes, or turn them on for the specified axes and +## off for the remainder. ## ## @item @qcode{"label[xyz]"} -## Turn tic labels on for all axes, or turn them on for the -## specified axes and off for the remainder. +## Turn tic labels on for all axes, or turn them on for the specified axes +## and off for the remainder. ## ## @item @qcode{"nolabel"} ## Turn tic labels off for all axes. @@ -125,8 +123,8 @@ ## Restore y-axis, so higher values are nearer the top. ## @end table ## -## If the first argument @var{hax} is an axes handle, then operate on -## this axes rather than the current axes returned by @code{gca}. +## If the first argument @var{hax} is an axes handle, then operate on this +## axes rather than the current axes returned by @code{gca}. ## ## @seealso{xlim, ylim, zlim, daspect, pbaspect, box, grid} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/appearance/box.m --- a/scripts/plot/appearance/box.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/appearance/box.m Sat May 09 22:50:09 2015 -0700 @@ -26,8 +26,8 @@ ## The argument may be either @qcode{"on"} or @qcode{"off"}. If it is ## omitted, the current box state is toggled. ## -## If the first argument @var{hax} is an axes handle, then operate on -## this axis rather than the current axes returned by @code{gca}. +## If the first argument @var{hax} is an axes handle, then operate on this +## axis rather than the current axes returned by @code{gca}. ## @seealso{axis, grid} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/appearance/caxis.m --- a/scripts/plot/appearance/caxis.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/appearance/caxis.m Sat May 09 22:50:09 2015 -0700 @@ -24,10 +24,10 @@ ## @deftypefnx {Function File} {@var{limits} =} caxis () ## Query or set color axis limits for plots. ## -## The limits argument should be a 2-element vector specifying the -## lower and upper limits to assign to the first and last value in the -## colormap. Data values outside this range are clamped to the first and last -## colormap entries. +## The limits argument should be a 2-element vector specifying the lower and +## upper limits to assign to the first and last value in the colormap. Data +## values outside this range are clamped to the first and last colormap +## entries. ## ## If the @qcode{"auto"} option is given then automatic colormap limits are ## applied. The automatic algorithm sets @var{cmin} to the minimum data value diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/appearance/datetick.m --- a/scripts/plot/appearance/datetick.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/appearance/datetick.m Sat May 09 22:50:09 2015 -0700 @@ -23,10 +23,13 @@ ## @deftypefnx {Function File} {} datetick (@dots{}, "keeplimits") ## @deftypefnx {Function File} {} datetick (@dots{}, "keepticks") ## @deftypefnx {Function File} {} datetick (@var{hax}, @dots{}) -## Add date formatted tick labels to an axis. The axis to apply the -## ticks to is determined by @var{axis} which can take the values @qcode{"x"}, -## @qcode{"y"}, or @qcode{"z"}. The default value is @qcode{"x"}. The -## formatting of the labels is determined by the variable @var{form}, which +## Add date formatted tick labels to an axis. +## +## The axis to apply the ticks to is determined by @var{axis} which can take +## the values @qcode{"x"}, @qcode{"y"}, or @qcode{"z"}. The default value is +## @qcode{"x"}. +## +## The formatting of the labels is determined by the variable @var{form}, which ## can either be a string or positive integer that @code{datestr} accepts. ## @seealso{datenum, datestr} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/appearance/hidden.m --- a/scripts/plot/appearance/hidden.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/appearance/hidden.m Sat May 09 22:50:09 2015 -0700 @@ -24,6 +24,7 @@ ## Control mesh hidden line removal. ## ## When called with no argument the hidden line removal state is toggled. +## ## When called with one of the modes @qcode{"on"} or @qcode{"off"} the state ## is set accordingly. ## diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/appearance/legend.m --- a/scripts/plot/appearance/legend.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/appearance/legend.m Sat May 09 22:50:09 2015 -0700 @@ -56,8 +56,8 @@ ## @item @tab outside @tab can be appended to any location string ## @end multitable ## -## The optional parameter @var{orient} determines if the key elements -## are placed vertically or horizontally. The allowed values are +## The optional parameter @var{orient} determines if the key elements are +## placed vertically or horizontally. The allowed values are ## @qcode{"vertical"} (default) or @qcode{"horizontal"}. ## ## The following customizations are available using @var{option}: diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/appearance/xlim.m --- a/scripts/plot/appearance/xlim.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/appearance/xlim.m Sat May 09 22:50:09 2015 -0700 @@ -26,8 +26,10 @@ ## Query or set the limits of the x-axis for the current plot. ## ## Called without arguments @code{xlim} returns the x-axis limits of the -## current plot. With the input query @qcode{"mode"}, return the current -## x-limit calculation mode which is either @qcode{"auto"} or @qcode{"manual"}. +## current plot. +## +## With the input query @qcode{"mode"}, return the current x-limit +## calculation mode which is either @qcode{"auto"} or @qcode{"manual"}. ## ## If passed a 2-element vector [@var{x_lo} @var{x_hi}], the limits of the ## x-axis are set to these values and the mode is set to @qcode{"manual"}. diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/appearance/ylim.m --- a/scripts/plot/appearance/ylim.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/appearance/ylim.m Sat May 09 22:50:09 2015 -0700 @@ -26,7 +26,9 @@ ## Query or set the limits of the y-axis for the current plot. ## ## Called without arguments @code{ylim} returns the y-axis limits of the -## current plot. With the input query @qcode{"mode"}, return the current +## current plot. +## +## With the input query @qcode{"mode"}, return the current ## y-limit calculation mode which is either @qcode{"auto"} or @qcode{"manual"}. ## ## If passed a 2-element vector [@var{y_lo} @var{y_hi}], the limits of the diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/appearance/zlim.m --- a/scripts/plot/appearance/zlim.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/appearance/zlim.m Sat May 09 22:50:09 2015 -0700 @@ -26,7 +26,9 @@ ## Query or set the limits of the z-axis for the current plot. ## ## Called without arguments @code{zlim} returns the z-axis limits of the -## current plot. With the input query @qcode{"mode"}, return the current +## current plot. +## +## With the input query @qcode{"mode"}, return the current ## z-limit calculation mode which is either @qcode{"auto"} or @qcode{"manual"}. ## ## If passed a 2-element vector [@var{z_lo} @var{z_hi}], the limits of the diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/area.m --- a/scripts/plot/draw/area.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/area.m Sat May 09 22:50:09 2015 -0700 @@ -26,8 +26,8 @@ ## @deftypefnx {Function File} {@var{h} =} area (@dots{}) ## Area plot of the columns of @var{y}. ## -## This plot shows the contributions of each column value to the row sum. It -## is functionally similar to @code{plot (@var{x}, cumsum (@var{y}, 2))}, +## This plot shows the contributions of each column value to the row sum. +## It is functionally similar to @code{plot (@var{x}, cumsum (@var{y}, 2))}, ## except that the area under the curve is shaded. ## ## If the @var{x} argument is omitted it defaults to @code{1:rows (@var{y})}. diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/comet.m --- a/scripts/plot/draw/comet.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/comet.m Sat May 09 22:50:09 2015 -0700 @@ -22,8 +22,9 @@ ## @deftypefnx {Function File} {} comet (@var{x}, @var{y}, @var{p}) ## @deftypefnx {Function File} {} comet (@var{hax}, @dots{}) ## Produce a simple comet style animation along the trajectory provided by -## the input coordinate vectors (@var{x}, @var{y}). If @var{x} is not -## specified it defaults to the indices of @var{y}. +## the input coordinate vectors (@var{x}, @var{y}). +## +## If @var{x} is not specified it defaults to the indices of @var{y}. ## ## The speed of the comet may be controlled by @var{p}, which represents the ## time each point is displayed before moving to the next one. The default for diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/comet3.m --- a/scripts/plot/draw/comet3.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/comet3.m Sat May 09 22:50:09 2015 -0700 @@ -22,8 +22,10 @@ ## @deftypefnx {Function File} {} comet3 (@var{x}, @var{y}, @var{z}, @var{p}) ## @deftypefnx {Function File} {} comet3 (@var{hax}, @dots{}) ## Produce a simple comet style animation along the trajectory provided by -## the input coordinate vectors (@var{x}, @var{y}, @var{z}). If only @var{z} -## is specified then @var{x}, @var{y} default to the indices of @var{z}. +## the input coordinate vectors (@var{x}, @var{y}, @var{z}). +## +## If only @var{z} is specified then @var{x}, @var{y} default to the indices +## of @var{z}. ## ## The speed of the comet may be controlled by @var{p}, which represents the ## time each point is displayed before moving to the next one. The default for diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/contour.m --- a/scripts/plot/draw/contour.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/contour.m Sat May 09 22:50:09 2015 -0700 @@ -37,7 +37,8 @@ ## If the first argument @var{hax} is an axes handle, then plot into this axis, ## rather than the current axes returned by @code{gca}. ## -## The optional output @var{c} are the contour levels in @code{contourc} format. +## The optional output @var{c} contains the contour levels in @code{contourc} +## format. ## ## The optional return value @var{h} is a graphics handle to the hggroup ## comprising the contour lines. diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/contourf.m --- a/scripts/plot/draw/contourf.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/contourf.m Sat May 09 22:50:09 2015 -0700 @@ -41,7 +41,8 @@ ## If the first argument @var{hax} is an axes handle, then plot into this axis, ## rather than the current axes returned by @code{gca}. ## -## The optional output @var{c} are the contour levels in @code{contourc} format. +## The optional output @var{c} contains the contour levels in @code{contourc} +## format. ## ## The optional return value @var{h} is a graphics handle to the hggroup ## comprising the contour lines. diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/isocolors.m --- a/scripts/plot/draw/isocolors.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/isocolors.m Sat May 09 22:50:09 2015 -0700 @@ -24,6 +24,8 @@ ## @deftypefnx {Function File} {[@var{cd}] =} isocolors (@dots{}, @var{p}) ## @deftypefnx {Function File} {} isocolors (@dots{}) ## +## Compute isosurface colors. +## ## If called with one output argument and the first input argument ## @var{c} is a three-dimensional array that contains color values and ## the second input argument @var{v} keeps the vertices of a geometry diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/isonormals.m --- a/scripts/plot/draw/isonormals.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/isonormals.m Sat May 09 22:50:09 2015 -0700 @@ -24,6 +24,8 @@ ## @deftypefnx {Function File} {[@var{n}] =} isonormals (@dots{}, "negate") ## @deftypefnx {Function File} {} isonormals (@dots{}, @var{p}) ## +## Calculate normals to an isosurface. +## ## If called with one output argument and the first input argument ## @var{val} is a three-dimensional array that contains the data for an ## isosurface geometry and the second input argument @var{v} keeps the diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/isosurface.m --- a/scripts/plot/draw/isosurface.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/isosurface.m Sat May 09 22:50:09 2015 -0700 @@ -25,6 +25,8 @@ ## @deftypefnx {Function File} {[@var{f}, @var{v}, @var{c}] =} isosurface (@var{x}, @var{y}, @var{z}, @var{val}, @var{iso}, @var{col}) ## @deftypefnx {Function File} {} isosurface (@var{x}, @var{y}, @var{z}, @var{val}, @var{iso}, @var{col}, @var{opt}) ## +## Calculate isosurface of 3-D data. +## ## If called with one output argument and the first input argument ## @var{val} is a three-dimensional array that contains the data of an ## isosurface geometry and the second input argument @var{iso} keeps the diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/plotmatrix.m --- a/scripts/plot/draw/plotmatrix.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/plotmatrix.m Sat May 09 22:50:09 2015 -0700 @@ -24,14 +24,14 @@ ## @deftypefnx {Function File} {[@var{h}, @var{ax}, @var{bigax}, @var{p}, @var{pax}] =} plotmatrix (@dots{}) ## Scatter plot of the columns of one matrix against another. ## -## Given the arguments @var{x} and @var{y}, that have a matching number of +## Given the arguments @var{x} and @var{y} that have a matching number of ## rows, @code{plotmatrix} plots a set of axes corresponding to ## ## @example ## plot (@var{x}(:, i), @var{y}(:, j)) ## @end example ## -## Given a single argument @var{x} this is equivalent to +## When called with a single argument @var{x} this is equivalent to ## ## @example ## plotmatrix (@var{x}, @var{x}) @@ -49,11 +49,14 @@ ## ## The optional return value @var{h} provides handles to the individual ## graphics objects in the scatter plots, whereas @var{ax} returns the -## handles to the scatter plot axis objects. @var{bigax} is a hidden -## axis object that surrounds the other axes, such that the commands -## @code{xlabel}, @code{title}, etc., will be associated with this hidden -## axis. Finally, @var{p} returns the graphics objects associated with -## the histogram and @var{pax} the corresponding axes objects. +## handles to the scatter plot axis objects. +## +## @var{bigax} is a hidden axis object that surrounds the other axes, such +## that the commands @code{xlabel}, @code{title}, etc., will be associated +## with this hidden axis. +## +## Finally, @var{p} returns the graphics objects associated with the histogram +## and @var{pax} the corresponding axes objects. ## ## Example: ## diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/quiver.m --- a/scripts/plot/draw/quiver.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/quiver.m Sat May 09 22:50:09 2015 -0700 @@ -25,9 +25,11 @@ ## @deftypefnx {Function File} {} quiver (@var{hax}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} quiver (@dots{}) ## +## Plot a 2-D vector field with arrows. +## ## Plot the (@var{u}, @var{v}) components of a vector field in -## an (@var{x}, @var{y}) meshgrid. If the grid is uniform, you can -## specify @var{x} and @var{y} as vectors. +## an (@var{x}, @var{y}) meshgrid. If the grid is uniform then @var{x} and +## @var{y} can be specified as vectors. ## ## If @var{x} and @var{y} are undefined they are assumed to be ## @code{(1:@var{m}, 1:@var{n})} where diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/quiver3.m --- a/scripts/plot/draw/quiver3.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/quiver3.m Sat May 09 22:50:09 2015 -0700 @@ -25,9 +25,11 @@ ## @deftypefnx {Function File} {} quiver3 (@var{hax}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} quiver3 (@dots{}) ## +## Plot a 3-D vector field with arrows. +## ## Plot the (@var{u}, @var{v}, @var{w}) components of a vector field in -## an (@var{x}, @var{y}, @var{z}) meshgrid. If the grid is uniform, you -## can specify @var{x}, @var{y}, and @var{z} as vectors. +## an (@var{x}, @var{y}, @var{z}) meshgrid. If the grid is uniform then +## @var{x}, @var{y}, and @var{z} can be specified as vectors. ## ## If @var{x}, @var{y}, and @var{z} are undefined they are assumed to be ## @code{(1:@var{m}, 1:@var{n}, 1:@var{p})} where @code{[@var{m}, @var{n}] = diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/ribbon.m --- a/scripts/plot/draw/ribbon.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/ribbon.m Sat May 09 22:50:09 2015 -0700 @@ -22,7 +22,7 @@ ## @deftypefnx {Function File} {} ribbon (@var{x}, @var{y}, @var{width}) ## @deftypefnx {Function File} {} ribbon (@var{hax}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} ribbon (@dots{}) -## Plot a ribbon plot for the columns of @var{y} vs. @var{x}. +## Draw a ribbon plot for the columns of @var{y} vs. @var{x}. ## ## The optional parameter @var{width} specifies the width of a single ribbon ## (default is 0.75). If @var{x} is omitted, a vector containing the diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/semilogxerr.m --- a/scripts/plot/draw/semilogxerr.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/semilogxerr.m Sat May 09 22:50:09 2015 -0700 @@ -27,8 +27,8 @@ ## @deftypefnx {Function File} {} semilogxerr (@var{x1}, @var{y1}, @dots{}, @var{fmt}, @var{xn}, @var{yn}, @dots{}) ## @deftypefnx {Function File} {} semilogxerr (@var{hax}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} semilogxerr (@dots{}) -## Produce 2-D plots using a logarithmic scale for the x-axis and -## errorbars at each data point. +## Produce 2-D plots using a logarithmic scale for the x-axis and errorbars +## at each data point. ## ## Many different combinations of arguments are possible. The most common ## form is diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/semilogyerr.m --- a/scripts/plot/draw/semilogyerr.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/semilogyerr.m Sat May 09 22:50:09 2015 -0700 @@ -27,8 +27,8 @@ ## @deftypefnx {Function File} {} semilogyerr (@var{x1}, @var{y1}, @dots{}, @var{fmt}, @var{xn}, @var{yn}, @dots{}) ## @deftypefnx {Function File} {} semilogyerr (@var{hax}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} semilogyerr (@dots{}) -## Produce 2-D plots using a logarithmic scale for the y-axis and -## errorbars at each data point. +## Produce 2-D plots using a logarithmic scale for the y-axis and errorbars +## at each data point. ## ## Many different combinations of arguments are possible. The most common ## form is diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/sphere.m --- a/scripts/plot/draw/sphere.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/sphere.m Sat May 09 22:50:09 2015 -0700 @@ -24,7 +24,7 @@ ## Plot a 3-D unit sphere. ## ## The optional input @var{n} determines the number of faces around the -## the circumference of the sphere. The default value is 20. +## circumference of the sphere. The default value is 20. ## ## If the first argument @var{hax} is an axes handle, then plot into this axis, ## rather than the current axes returned by @code{gca}. diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/surfl.m --- a/scripts/plot/draw/surfl.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/surfl.m Sat May 09 22:50:09 2015 -0700 @@ -25,7 +25,6 @@ ## @deftypefnx {Function File} {} surfl (@dots{}, "light") ## @deftypefnx {Function File} {} surfl (@var{hax}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} surfl (@dots{}) -## ## Plot a 3-D surface using shading based on various lighting models. ## ## The surface mesh is plotted using shaded rectangles. The vertices of the diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/draw/tetramesh.m --- a/scripts/plot/draw/tetramesh.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/draw/tetramesh.m Sat May 09 22:50:09 2015 -0700 @@ -23,10 +23,10 @@ ## @deftypefnx {Function File} {@var{h} =} tetramesh (@dots{}) ## Display the tetrahedrons defined in the m-by-4 matrix @var{T} as 3-D patches. ## -## @var{T} is typically the output of a Delaunay triangulation -## of a 3-D set of points. Every row of @var{T} contains four indices into -## the n-by-3 matrix @var{X} of the vertices of a tetrahedron. Every row in -## @var{X} represents one point in 3-D space. +## @var{T} is typically the output of a Delaunay triangulation of a 3-D set +## of points. Every row of @var{T} contains four indices into the n-by-3 +## matrix @var{X} of the vertices of a tetrahedron. Every row in @var{X} +## represents one point in 3-D space. ## ## The vector @var{C} specifies the color of each tetrahedron as an index ## into the current colormap. The default value is 1:m where m is the number diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/allchild.m --- a/scripts/plot/util/allchild.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/allchild.m Sat May 09 22:50:09 2015 -0700 @@ -21,10 +21,11 @@ ## Find all children, including hidden children, of a graphics object. ## ## This function is similar to @code{get (h, "children")}, but also returns -## hidden objects (HandleVisibility = @qcode{"off"}). If @var{handles} is a -## scalar, @var{h} will be a vector. Otherwise, @var{h} will be a cell -## matrix of the same size as @var{handles} and each cell will contain a -## vector of handles. +## hidden objects (HandleVisibility = @qcode{"off"}). +## +## If @var{handles} is a scalar, @var{h} will be a vector. Otherwise, +## @var{h} will be a cell matrix of the same size as @var{handles} and each +## cell will contain a vector of handles. ## @seealso{findall, findobj, get, set} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/ancestor.m --- a/scripts/plot/util/ancestor.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/ancestor.m Sat May 09 22:50:09 2015 -0700 @@ -20,9 +20,10 @@ ## @deftypefn {Function File} {@var{parent} =} ancestor (@var{h}, @var{type}) ## @deftypefnx {Function File} {@var{parent} =} ancestor (@var{h}, @var{type}, "toplevel") ## Return the first ancestor of handle object @var{h} whose type matches -## @var{type}, where @var{type} is a character string. If @var{type} is a -## cell array of strings, return the first parent whose type matches -## any of the given type strings. +## @var{type}, where @var{type} is a character string. +## +## If @var{type} is a cell array of strings, return the first parent whose +## type matches any of the given type strings. ## ## If the handle object @var{h} itself is of type @var{type}, return @var{h}. ## diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/axes.m --- a/scripts/plot/util/axes.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/axes.m Sat May 09 22:50:09 2015 -0700 @@ -21,8 +21,8 @@ ## @deftypefnx {Function File} {} axes (@var{property}, @var{value}, @dots{}) ## @deftypefnx {Function File} {} axes (@var{hax}) ## @deftypefnx {Function File} {@var{h} =} axes (@dots{}) -## Create an axes object and return a handle to it, or set the current -## axes to @var{hax}. +## Create an axes object and return a handle to it, or set the current axes +## to @var{hax}. ## ## Called without any arguments, or with @var{property}/@var{value} pairs, ## construct a new axes. For accepted properties and corresponding diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/colstyle.m --- a/scripts/plot/util/colstyle.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/colstyle.m Sat May 09 22:50:09 2015 -0700 @@ -19,6 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{style}, @var{color}, @var{marker}, @var{msg}] =} colstyle (@var{linespec}) ## Parse @var{linespec} and return the line style, color, and markers given. +## ## In the case of an error, the string @var{msg} will return the text of the ## error. ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/frame2im.m --- a/scripts/plot/util/frame2im.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/frame2im.m Sat May 09 22:50:09 2015 -0700 @@ -25,8 +25,8 @@ ## ## Support for N-dimensional images or movies is given when @var{f} is a ## struct array. In such cases, @var{x} will be a @nospell{MxNx1xK or MxNx3xK} -## for indexed and RGB movies respectively, with each frame concatenated on -## the 4th dimension. +## for indexed and RGB movies respectively, with each frame concatenated +## along the 4th dimension. ## ## @seealso{im2frame} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/gnuplot_binary.in --- a/scripts/plot/util/gnuplot_binary.in Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/gnuplot_binary.in Sat May 09 22:50:09 2015 -0700 @@ -19,10 +19,11 @@ ## -*- 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{}) -## Query or set the name of the program invoked by the plot command -## when the graphics toolkit is set to "gnuplot". Additional arguments to -## pass to the external plotting program may also be given. -## The default value is @qcode{"gnuplot"} with no additional arguments. +## Query or set the name of the program invoked by the plot command when the +## graphics toolkit is set to "gnuplot". +## +## Additional arguments to pass to the external plotting program may also be +## given. The default value is @qcode{"gnuplot"} with no additional arguments. ## @xref{Installation}. ## @seealso{graphics_toolkit} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/hgsave.m --- a/scripts/plot/util/hgsave.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/hgsave.m Sat May 09 22:50:09 2015 -0700 @@ -24,9 +24,11 @@ ## @var{fmt}. ## ## If unspecified, @var{h} is the current figure as returned by @code{gcf}. +## ## When @var{filename} does not have an extension the default filename -## extension @file{.ofig} will be appended. If present, @var{fmt} should -## should be one of the following: +## extension @file{.ofig} will be appended. +## +## If present, @var{fmt} should be one of the following: ## ## @itemize @bullet ## @item @option{-binary}, @option{-float-binary} diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/im2frame.m --- a/scripts/plot/util/im2frame.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/im2frame.m Sat May 09 22:50:09 2015 -0700 @@ -25,8 +25,9 @@ ## @qcode{"colormap"}. ## ## Support for N-dimensional images is given when each image projection, -## matrix sizes of @nospell{MxN and MxNx3} for RGB images, is concatenated on -## the fourth dimension. In such cases, the returned value is a struct array. +## matrix sizes of @nospell{MxN and MxNx3} for RGB images, is concatenated +## along the fourth dimension. In such cases, the returned value is a struct +## array. ## ## @seealso{frame2im} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/isaxes.m --- a/scripts/plot/util/isaxes.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/isaxes.m Sat May 09 22:50:09 2015 -0700 @@ -20,9 +20,8 @@ ## @deftypefn {Function File} {} isaxes (@var{h}) ## Return true if @var{h} is an axes graphics handle and false otherwise. ## -## If @var{h} is a matrix then return a logical array which is true where -## the elements of @var{h} are axes graphics handles and false where -## they are not. +## If @var{h} is a matrix then return a logical array which is true where the +## elements of @var{h} are axes graphics handles and false where they are not. ## @seealso{isaxes, ishandle} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/isfigure.m --- a/scripts/plot/util/isfigure.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/isfigure.m Sat May 09 22:50:09 2015 -0700 @@ -20,9 +20,8 @@ ## @deftypefn {Function File} {} isfigure (@var{h}) ## Return true if @var{h} is a figure graphics handle and false otherwise. ## -## If @var{h} is a matrix then return a logical array which is true where -## the elements of @var{h} are figure graphics handles and false where -## they are not. +## If @var{h} is a matrix then return a logical array which is true where the +## elements of @var{h} are figure graphics handles and false where they are not. ## @seealso{isaxes, ishandle} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/linkaxes.m --- a/scripts/plot/util/linkaxes.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/linkaxes.m Sat May 09 22:50:09 2015 -0700 @@ -19,8 +19,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} linkaxes (@var{hax}) ## @deftypefnx {Function File} {} linkaxes (@var{hax}, @var{optstr}) -## Link the axis limits of 2-D plots such that a change in one is -## propagated to the others. +## Link the axis limits of 2-D plots such that a change in one is propagated +## to the others. ## ## The axes handles to be linked are passed as the first argument @var{hax}. ## diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/ndgrid.m --- a/scripts/plot/util/ndgrid.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/ndgrid.m Sat May 09 22:50:09 2015 -0700 @@ -19,12 +19,13 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{y1}, @var{y2}, @dots{}, @var{y}n] =} ndgrid (@var{x1}, @var{x2}, @dots{}, @var{x}n) ## @deftypefnx {Function File} {[@var{y1}, @var{y2}, @dots{}, @var{y}n] =} ndgrid (@var{x}) -## Given n vectors @var{x1}, @dots{}, @var{x}n, @code{ndgrid} returns -## n arrays of dimension n. The elements of the i-th output argument -## contains the elements of the vector @var{x}i repeated over all -## dimensions different from the i-th dimension. Calling ndgrid with -## only one input argument @var{x} is equivalent to calling ndgrid with -## all n input arguments equal to @var{x}: +## Given n vectors @var{x1}, @dots{}, @var{x}n, @code{ndgrid} returns n +## arrays of dimension n. +## +## The elements of the i-th output argument contains the elements of the +## vector @var{x}i repeated over all dimensions different from the i-th +## dimension. Calling ndgrid with only one input argument @var{x} is +## equivalent to calling ndgrid with all n input arguments equal to @var{x}: ## ## [@var{y1}, @var{y2}, @dots{}, @var{y}n] = ndgrid (@var{x}, @dots{}, @var{x}) ## diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/pan.m --- a/scripts/plot/util/pan.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/pan.m Sat May 09 22:50:09 2015 -0700 @@ -33,9 +33,8 @@ ## Given the option @qcode{"xon"} or @qcode{"yon"}, enable pan mode ## for the x or y axis only. ## -## If the first argument @var{hfig} is a figure, then operate on -## the given figure rather than the current figure as returned by -## @code{gcf}. +## If the first argument @var{hfig} is a figure, then operate on the given +## figure rather than the current figure as returned by @code{gcf}. ## ## @seealso{rotate3d, zoom} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/print.m --- a/scripts/plot/util/print.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/print.m Sat May 09 22:50:09 2015 -0700 @@ -26,20 +26,19 @@ ## Both output formatted for printing (PDF and PostScript), and many bitmapped ## and vector image formats are supported. ## -## @var{filename} defines the name of the output file. If the -## file name has no suffix, one is inferred from the specified -## device and appended to the file name. If no filename is -## specified, the output is sent to the printer. +## @var{filename} defines the name of the output file. If the file name has +## no suffix, one is inferred from the specified device and appended to the +## file name. If no filename is specified, the output is sent to the +## printer. ## ## @var{h} specifies the handle of the figure to print. If no handle is ## specified the current figure is used. ## -## For output to a printer, PostScript file, or PDF file, -## the paper size is specified by the figure's @code{papersize} -## property. The location and size of the image on the page are -## specified by the figure's @code{paperposition} property. The -## orientation of the page is specified by the figure's -## @code{paperorientation} property. +## For output to a printer, PostScript file, or PDF file, the paper size is +## specified by the figure's @code{papersize} property. The location and +## size of the image on the page are specified by the figure's +## @code{paperposition} property. The orientation of the page is specified +## by the figure's @code{paperorientation} property. ## ## The width and height of images are specified by the figure's ## @code{paperpositon(3:4)} property values. @@ -48,16 +47,16 @@ ## ## @table @code ## @item -f@var{h} -## Specify the handle, @var{h}, of the figure to be printed. The -## default is the current figure. +## Specify the handle, @var{h}, of the figure to be printed. The default +## is the current figure. ## ## @item -P@var{printer} ## Set the @var{printer} name to which the plot is sent if no ## @var{filename} is specified. ## ## @item -G@var{ghostscript_command} -## Specify the command for calling Ghostscript. For Unix and Windows -## the defaults are @qcode{"gs"} and @qcode{"gswin32c"}, respectively. +## Specify the command for calling Ghostscript. For Unix and Windows the +## defaults are @qcode{"gs"} and @qcode{"gswin32c"}, respectively. ## ## @item -color ## @itemx -mono @@ -69,24 +68,23 @@ ## ## @item -portrait ## @itemx -landscape -## Specify the orientation of the plot for printed output. For -## non-printed output the aspect ratio of the output corresponds to -## the plot area defined by the @qcode{"paperposition"} property in the -## orientation specified. This option is equivalent to changing -## the figure's @qcode{"paperorientation"} property. +## Specify the orientation of the plot for printed output. +## For non-printed output the aspect ratio of the output corresponds to the +## plot area defined by the @qcode{"paperposition"} property in the +## orientation specified. This option is equivalent to changing the figure's +## @qcode{"paperorientation"} property. ## ## @item -TextAlphaBits=@var{n} ## @itemx -GraphicsAlphaBits=@var{n} ## Octave is able to produce output for various printers, bitmaps, and -## vector formats by using Ghostscript. -## For bitmap and printer output anti-aliasing is applied using -## Ghostscript's TextAlphaBits and GraphicsAlphaBits options. -## The default number of bits for each is 4. +## vector formats by using Ghostscript. For bitmap and printer output +## anti-aliasing is applied using Ghostscript's TextAlphaBits and +## GraphicsAlphaBits options. The default number of bits for each is 4. ## Allowed values for @var{N} are 1, 2, or 4. ## ## @item -d@var{device} -## The available output format is specified by the option @var{device}, -## and is one of: +## The available output format is specified by the option @var{device}, and +## is one of: ## ## @table @code ## @item ps @@ -148,9 +146,7 @@ ## ## @item fig ## XFig. For the Gnuplot graphics toolkit, the additional options -## @option{-textspecial} or @option{-textnormal} can be used to control -## whether the special flag should be set for the text in -## the figure. (default is @option{-textnormal}) +## @option{-textspecial} or @option{-textnormal} can be used to control whether the special flag should be set for the text in the figure. (default is @option{-textnormal}) ## ## @item hpgl ## HP plotter language @@ -202,18 +198,18 @@ ## For a complete list, type @code{system ("gs -h")} to see what formats ## and devices are available. ## -## When Ghostscript output is sent to a printer the size is determined -## by the figure's @qcode{"papersize"} property. When the output -## is sent to a file the size is determined by the plot box defined by -## the figure's @qcode{"paperposition"} property. +## When Ghostscript output is sent to a printer the size is determined by +## the figure's @qcode{"papersize"} property. When the output is sent to a +## file the size is determined by the plot box defined by the figure's +## @qcode{"paperposition"} property. ## ## @item -append ## Append PostScript or PDF output to a pre-existing file of the same type. ## ## @item -r@var{NUM} -## Resolution of bitmaps in pixels per inch. For both metafiles and -## SVG the default is the screen resolution; for other formats it is 150 dpi. -## To specify screen resolution, use @qcode{"-r0"}. +## Resolution of bitmaps in pixels per inch. For both metafiles and SVG +## the default is the screen resolution; for other formats it is 150 dpi. To +## specify screen resolution, use @qcode{"-r0"}. ## ## @item -loose ## @itemx -tight @@ -237,12 +233,12 @@ ## @end table ## ## @item -S@var{xsize},@var{ysize} -## Plot size in pixels for EMF, GIF, JPEG, PBM, PNG, and SVG@. For -## PS, EPS, PDF, and other vector formats the plot size is in points. -## This option is equivalent to changing the size of the plot box -## associated with the @qcode{"paperposition"} property. When using the -## command form of the print function you must quote the -## @var{xsize},@var{ysize} option. For example, by writing @w{"-S640,480"}. +## Plot size in pixels for EMF, GIF, JPEG, PBM, PNG, and SVG@. +## For PS, EPS, PDF, and other vector formats the plot size is in points. +## This option is equivalent to changing the size of the plot box associated +## with the @qcode{"paperposition"} property. When using the command form of +## the print function you must quote the @var{xsize},@var{ysize} option. For +## example, by writing @w{"-S640,480"}. ## ## @item -F@var{fontname} ## @itemx -F@var{fontname}:@var{size} diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/printd.m --- a/scripts/plot/util/printd.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/printd.m Sat May 09 22:50:09 2015 -0700 @@ -22,12 +22,14 @@ ## @deftypefn {Function File} {} printd (@var{obj}, @var{filename}) ## @deftypefnx {Function File} {@var{out_file} =} printd (@dots{}) ## -## Convert any object acceptable to @code{disp} into the format -## selected by the suffix of @var{filename}. If the return argument -## @var{out_file} is given, the name of the created file is returned. +## Convert any object acceptable to @code{disp} into the format selected by +## the suffix of @var{filename}. ## -## This function is intended to facilitate manipulation of the output -## of functions such as @code{stemleaf}. +## If the return argument @var{out_file} is given, the name of the created +## file is returned. +## +## This function is intended to facilitate manipulation of the output of +## functions such as @code{stemleaf}. ## @seealso{stemleaf} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/private/__add_default_menu__.m --- a/scripts/plot/util/private/__add_default_menu__.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/private/__add_default_menu__.m Sat May 09 22:50:09 2015 -0700 @@ -18,8 +18,10 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} __add_default_menu__ (@var{fig}) -## Add default menu to figure. All uimenu handles have -## their @qcode{"HandleVisibility"} property set to @qcode{"off"}. +## Add default menu to figure. +## +## All uimenu handles have their @qcode{"HandleVisibility"} property set to +## @qcode{"off"}. ## @end deftypefn ## Author: Kai Habel diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/rotate.m --- a/scripts/plot/util/rotate.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/rotate.m Sat May 09 22:50:09 2015 -0700 @@ -19,17 +19,17 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} rotate (@var{h}, @var{dir}, @var{alpha}) ## @deftypefnx {Function File} {} rotate (@dots{}, @var{origin}) -## Rotate the plot object @var{h} through @var{alpha} degrees around -## the line with direction @var{dir} and origin @var{origin}. +## Rotate the plot object @var{h} through @var{alpha} degrees around the line +## with direction @var{dir} and origin @var{origin}. ## -## The default value of @var{origin} is the center of the axes -## object that is the parent of @var{h}. +## The default value of @var{origin} is the center of the axes object that is +## the parent of @var{h}. ## -## If @var{h} is a vector of handles, they must all have the same -## parent axes object. +## If @var{h} is a vector of handles, they must all have the same parent axes +## object. ## -## Graphics objects that may be rotated are lines, surfaces, patches, -## and images. +## Graphics objects that may be rotated are lines, surfaces, patches, and +## images. ## @end deftypefn function rotate (h, direction, alpha, origin) diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/rotate3d.m --- a/scripts/plot/util/rotate3d.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/rotate3d.m Sat May 09 22:50:09 2015 -0700 @@ -28,9 +28,8 @@ ## ## With no arguments, toggle the current rotate mode on or off. ## -## If the first argument @var{hfig} is a figure, then operate on -## the given figure rather than the current figure as returned by -## @code{gcf}. +## If the first argument @var{hfig} is a figure, then operate on the given +## figure rather than the current figure as returned by @code{gcf}. ## ## @seealso{pan, zoom} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/saveas.m --- a/scripts/plot/util/saveas.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/saveas.m Sat May 09 22:50:09 2015 -0700 @@ -19,8 +19,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} saveas (@var{h}, @var{filename}) ## @deftypefnx {Function File} {} saveas (@var{h}, @var{filename}, @var{fmt}) -## Save graphic object @var{h} to the file @var{filename} in graphic -## format @var{fmt}. +## Save graphic object @var{h} to the file @var{filename} in graphic format +## @var{fmt}. ## ## @var{fmt} should be one of the following formats: ## diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/struct2hdl.m --- a/scripts/plot/util/struct2hdl.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/struct2hdl.m Sat May 09 22:50:09 2015 -0700 @@ -23,14 +23,15 @@ ## Construct a graphics handle object @var{h} from the structure @var{s}. ## ## The structure must contain the fields @qcode{"handle"}, @qcode{"type"}, -## @qcode{"children"}, @qcode{"properties"}, and @qcode{"special"}. If the -## handle of an existing figure or axes is specified, @var{p}, the new object -## will be created as a child of that object. If no parent handle is provided -## then a new figure and the necessary children will be constructed using the -## default values from the root figure. +## @qcode{"children"}, @qcode{"properties"}, and @qcode{"special"}. ## -## A third boolean argument @var{hilev} can be passed to specify whether -## the function should preserve listeners/callbacks, e.g., for legends or +## If the handle of an existing figure or axes is specified, @var{p}, the new +## object will be created as a child of that object. If no parent handle is +## provided then a new figure and the necessary children will be constructed +## using the default values from the root figure. +## +## A third boolean argument @var{hilev} can be passed to specify whether the +## function should preserve listeners/callbacks, e.g., for legends or ## hggroups. The default is false. ## @seealso{hdl2struct, hgload, findobj} ## @end deftypefn diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/subplot.m --- a/scripts/plot/util/subplot.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/subplot.m Sat May 09 22:50:09 2015 -0700 @@ -29,8 +29,8 @@ ## current axes for plotting (@code{gca}) to the location given by @var{index}. ## ## If only one numeric argument is supplied, then it must be a three digit -## value specifying the number of rows in digit 1, the number of -## columns in digit 2, and the plot index in digit 3. +## value specifying the number of rows in digit 1, the number of columns in +## digit 2, and the plot index in digit 3. ## ## The plot index runs row-wise; First, all columns in a row are numbered ## and then the next row is filled. diff -r 4f45eaf83908 -r 777f26aa8e3e scripts/plot/util/zoom.m --- a/scripts/plot/util/zoom.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/util/zoom.m Sat May 09 22:50:09 2015 -0700 @@ -26,31 +26,30 @@ ## @deftypefnx {Command} {} zoom out ## @deftypefnx {Command} {} zoom reset ## @deftypefnx {Command} {} zoom (@var{hfig}, @var{option}) -## Zoom the current axes object or control the interactive zoom mode of -## a figure in the GUI. +## Zoom the current axes object or control the interactive zoom mode of a +## figure in the GUI. ## -## Given a numeric argument greater than zero, zoom by the given factor. -## If the zoom factor is greater than one, zoom in on the plot. If the -## factor is less than one, zoom out. If the zoom factor is a two- or -## three-element vector, then the elements specify the zoom factors for -## the x, y, and z axes respectively. +## Given a numeric argument greater than zero, zoom by the given factor. If +## the zoom factor is greater than one, zoom in on the plot. If the factor +## is less than one, zoom out. If the zoom factor is a two- or three-element +## vector, then the elements specify the zoom factors for the x, y, and z +## axes respectively. ## -## Given the option @qcode{"on"} or @qcode{"off"}, set the interactive -## zoom mode on or off. +## Given the option @qcode{"on"} or @qcode{"off"}, set the interactive zoom +## mode on or off. ## ## With no arguments, toggle the current zoom mode on or off. ## -## Given the option @qcode{"xon"} or @qcode{"yon"}, enable zoom mode -## for the x or y axis only. +## Given the option @qcode{"xon"} or @qcode{"yon"}, enable zoom mode for the +## x or y-axis only. ## ## Given the option @qcode{"out"}, zoom to the initial zoom setting. ## -## Given the option @qcode{"reset"}, store the current zoom setting so -## that @code{zoom out} will return to this zoom level. +## Given the option @qcode{"reset"}, store the current zoom setting so that +## @code{zoom out} will return to this zoom level. ## -## If the first argument @var{hfig} is a figure, then operate on -## the given figure rather than the current figure as returned by -## @code{gcf}. +## If the first argument @var{hfig} is a figure, then operate on the given +## figure rather than the current figure as returned by @code{gcf}. ## ## @seealso{pan, rotate3d} ## @end deftypefn