octave-nkf: scripts/plot/ylabel.m annotate

annotate scripts/plot/ylabel.m @ 14001:5f0bb45e615c

doc: Update documentation for functions returning a graphics handle h (Bug #34761) * voronoi.m, image.m, imagesc.m, imshow.m, area.m, bar.m, barh.m, clabel.m, clf.m, compass.m, ezcontour.m, ezcontourf.m, ezmesh.m, ezmeshc.m, ezplot.m, ezplot3.m, ezpolar.m, ezsurf.m, ezsurfc.m, feather.m, fill.m, findall.m, findobj.m, loglog.m, mesh.m, pareto.m, patch.m, pie.m, pie3.m, plot.m, polar.m, quiver.m, quiver3.m, rectangle.m, ribbon.m, rose.m, scatter.m, scatter3.m, semilogx.m, semilogy.m, slice.m, stem.m, surf.m, surface.m, text.m, title.m, trimesh.m, triplot.m, trisurf.m, xlabel.m, ylabel.m, zlabel.m: Update documentation for functions returning a graphics handle h.

author	Rik <octave@nomad.inbox5.com>
date	Tue, 06 Dec 2011 13:09:17 -0800
parents	5acb5c25e4ae
children	72c96de7a403

rev	line source
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11315 diff changeset	1 ## Copyright (C) 1993-2011 John W. Eaton
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	6 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6412 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6412 diff changeset	8 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	15 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6412 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6412 diff changeset	17 ## <http://www.gnu.org/licenses/>.
245 16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe] jwe parents: 4 diff changeset	18
3458 d25bc039237b [project @ 2000-01-19 09:36:14 by jwe] jwe parents: 3446 diff changeset	19 ## -- texinfo --
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 8920 diff changeset	20 ## @deftypefn {Function File} {} ylabel (@var{string})
7194 a927a2871a93 [project @ 2007-11-26 23:06:12 by jwe] jwe parents: 7017 diff changeset	21 ## @deftypefnx {Function File} {} ylabel (@var{h}, @var{string})
11315 c715816f4539 Add additional calling form to docstring for [xyz]label functions. Rik <octave@nomad.inbox5.com> parents: 11152 diff changeset	22 ## @deftypefnx {Function File} {@var{h} =} ylabel (@dots{})
11152 39ae406df598 Improve docstrings for functions found in undocumented list. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	23 ## @seealso{xlabel}
3458 d25bc039237b [project @ 2000-01-19 09:36:14 by jwe] jwe parents: 3446 diff changeset	24 ## @end deftypefn
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 2847 diff changeset	25
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	26 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	27
7215 dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe] jwe parents: 7208 diff changeset	28 function retval = ylabel (varargin)
4529 78954aeaf321 [project @ 2003-10-04 19:35:36 by jwe] jwe parents: 3979 diff changeset	29
7215 dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe] jwe parents: 7208 diff changeset	30 [h, varargin, nargin] = __plt_get_axis_arg__ ("ylabel", varargin{:});
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe] jwe parents: 7208 diff changeset	31
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe] jwe parents: 7208 diff changeset	32 if (rem (nargin, 2) != 1)
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe] jwe parents: 7208 diff changeset	33 print_usage ();
7194 a927a2871a93 [project @ 2007-11-26 23:06:12 by jwe] jwe parents: 7017 diff changeset	34 endif
a927a2871a93 [project @ 2007-11-26 23:06:12 by jwe] jwe parents: 7017 diff changeset	35
13800 5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	36 tmp = __axis_label__ (h, "ylabel", varargin{:},
5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	37 "color", get (h, "ycolor"));
7215 dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe] jwe parents: 7208 diff changeset	38
7194 a927a2871a93 [project @ 2007-11-26 23:06:12 by jwe] jwe parents: 7017 diff changeset	39 if (nargout > 0)
7425 fe4a43e1d1d3 [project @ 2008-01-28 09:13:01 by jwe] jwe parents: 7271 diff changeset	40 retval = tmp;
4529 78954aeaf321 [project @ 2003-10-04 19:35:36 by jwe] jwe parents: 3979 diff changeset	41 endif
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	42
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	43 endfunction
13136 79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11598 diff changeset	44
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13800 diff changeset	45
13136 79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11598 diff changeset	46 %!test
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11598 diff changeset	47 %! hf = figure ("visible", "off");
13141 e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 13136 diff changeset	48 %! unwind_protect
13136 79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11598 diff changeset	49 %! y = ylabel ("ylabel_string");
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13800 diff changeset	50 %! assert (get (gca, "ylabel"), y);
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13800 diff changeset	51 %! assert (get (y, "type"), "text");
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13800 diff changeset	52 %! assert (get (y, "visible"), "on");
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13800 diff changeset	53 %! assert (get (y, "string"), "ylabel_string");
13136 79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11598 diff changeset	54 %! unwind_protect_cleanup
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11598 diff changeset	55 %! close (hf);
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11598 diff changeset	56 %! end_unwind_protect
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13800 diff changeset	57

Mercurial > octave-nkf

annotate scripts/plot/ylabel.m @ 14001:5f0bb45e615c