Mercurial > hg > octave-lyh
view scripts/plot/ylabel.m @ 16814:64e7bb01fce2
doc: Improve documentation for 2-D plot functions
* doc/interpreter/plot.txi: Rewrite documentation around get/set.
* libinterp/interpfcn/graphics.cc(Fget, Fset): Add seealso links. Add
additional calling forms for get().
* scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/comet.m,
scripts/plot/comet3.m, scripts/plot/contour.m, scripts/plot/contour3.m,
scripts/plot/contourc.m, scripts/plot/contourf.m, scripts/plot/errorbar.m,
scripts/plot/gca.m, scripts/plot/gcf.m, scripts/plot/gco.m,
scripts/plot/ishghandle.m, scripts/plot/loglogerr.m, scripts/plot/pareto.m,
scripts/plot/pcolor.m, scripts/plot/pie.m, scripts/plot/pie3.m,
scripts/plot/plotmatrix.m, scripts/plot/plotyy.m, scripts/plot/polar.m,
scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/rose.m,
scripts/plot/scatter.m, scripts/plot/semilogxerr.m, scripts/plot/semilogyerr.m,
scripts/plot/sombrero.m, scripts/plot/stairs.m, scripts/plot/stem.m,
scripts/plot/stem3.m: Improve docstrings.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 22 Jun 2013 17:40:52 -0700 |
parents | 72c96de7a403 |
children | 3f99d7d22bd0 |
line wrap: on
line source
## Copyright (C) 1993-2012 John W. Eaton ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} ylabel (@var{string}) ## @deftypefnx {Function File} {} ylabel (@var{h}, @var{string}) ## @deftypefnx {Function File} {@var{h} =} ylabel (@dots{}) ## @seealso{xlabel} ## @end deftypefn ## Author: jwe function retval = ylabel (varargin) [h, varargin, nargin] = __plt_get_axis_arg__ ("ylabel", varargin{:}); if (rem (nargin, 2) != 1) print_usage (); endif tmp = __axis_label__ (h, "ylabel", varargin{:}, "color", get (h, "ycolor")); if (nargout > 0) retval = tmp; endif endfunction %!test %! hf = figure ("visible", "off"); %! unwind_protect %! y = ylabel ("ylabel_string"); %! assert (get (gca, "ylabel"), y); %! assert (get (y, "type"), "text"); %! assert (get (y, "visible"), "on"); %! assert (get (y, "string"), "ylabel_string"); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect