Mercurial > hg > octave-lyh
diff scripts/plot/graphics_toolkit.m @ 16491:b10a23fe80bb
doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility.
* scripts/audio/wavread.m, scripts/miscellaneous/getappdata.m,
scripts/miscellaneous/license.m, scripts/miscellaneous/ver.m,
scripts/plot/daspect.m, scripts/plot/graphics_toolkit.m,
scripts/plot/pbaspect.m, scripts/polynomial/splinefit.m, scripts/set/union.m,
scripts/signal/freqz.m: Improve docstring wording.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 10 Apr 2013 22:43:30 -0700 |
parents | 36dba9be680b |
children | e39f00a32dc7 |
line wrap: on
line diff
--- a/scripts/plot/graphics_toolkit.m +++ b/scripts/plot/graphics_toolkit.m @@ -17,23 +17,27 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{name} =} graphics_toolkit () +## @deftypefn {Function File} {@var{name} =} graphics_toolkit () ## @deftypefnx {Function File} {@var{name} =} graphics_toolkit (@var{hlist}) ## @deftypefnx {Function File} {} graphics_toolkit (@var{name}) ## @deftypefnx {Function File} {} graphics_toolkit (@var{hlist}, @var{name}) +## Return the default graphics toolkit. The default graphics toolkit value +## is assigned to new figures. ## -## @code{graphics_toolkit (@var{hlist})} returns the default graphics toolkit. -## The default graphics toolkit value is assigned to new figures. +## @code{graphics_toolkit (@var{hlist})} ## -## @code{graphics_toolkit (@var{name})} returns the graphics toolkits -## for the figures with handles @var{hlist}. +## Return the graphics toolkits for the figures with handles @var{hlist}. +## +## @code{graphics_toolkit (@var{name})} ## -## @code{graphics_toolkit (@var{name})} sets the default graphics toolkit -## to @var{name}. If the toolkit is not already loaded, it is initialized -## by calling the function @code{__init_@var{name}__}. +## Set the default graphics toolkit to @var{name}. If the toolkit is not +## already loaded, it is initialized by calling the function +## @code{__init_@var{name}__}. ## -## @code{graphics_toolkit (@var{hlist}, @var{name})} sets the graphics toolkit -## for the figures with handles @var{hlist} to @var{name}. +## @code{graphics_toolkit (@var{hlist}, @var{name})} +## +## Set the graphics toolkit for the figures with handles @var{hlist} to +## @var{name}. ## ## @seealso{available_graphics_toolkits} ## @end deftypefn