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

annotate scripts/plot/xlabel.m @ 14552:86854d032a37

maint: miscellaneous style fixes for .m files * audio/mu2lin.m, deprecated/cut.m, general/cplxpair.m, general/genvarname.m, geometry/rectint.m, help/gen_doc_cache.m, image/hsv2rgb.m, image/rainbow.m, io/textscan.m, miscellaneous/bzip2.m, miscellaneous/compare_versions.m, miscellaneous/fact.m, miscellaneous/menu.m, optimization/fminbnd.m, optimization/fminunc.m, optimization/fzero.m, optimization/sqp.m, plot/__gnuplot_drawnow__.m, plot/axis.m, plot/findobj.m, plot/legend.m, plot/peaks.m, plot/private/__errplot__.m, plot/private/__fltk_print__.m, plot/private/__go_draw_axes__.m, plot/private/__patch__.m, polynomial/pchip.m, polynomial/residue.m, signal/periodogram.m, sparse/sprandsym.m, statistics/base/moment.m, statistics/distributions/expcdf.m, statistics/distributions/expinv.m, statistics/distributions/exppdf.m, statistics/tests/prop_test_2.m, statistics/tests/sign_test.m, statistics/tests/t_test.m, statistics/tests/t_test_2.m, statistics/tests/t_test_regression.m, strings/regexptranslate.m, time/datetick.m: Style fixes.

author	John W. Eaton <jwe@octave.org>
date	Wed, 11 Apr 2012 22:07:00 -0400
parents	72c96de7a403
children	3f99d7d22bd0

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 14001 diff changeset	1 ## Copyright (C) 1993-2012 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: 6895 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: 6895 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: 6895 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: 6895 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
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 2847 diff changeset	19 ## -- texinfo --
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 9758 diff changeset	20 ## @deftypefn {Function File} {} xlabel (@var{string})
7194 a927a2871a93 [project @ 2007-11-26 23:06:12 by jwe] jwe parents: 7017 diff changeset	21 ## @deftypefnx {Function File} {} xlabel (@var{h}, @var{string})
11315 c715816f4539 Add additional calling form to docstring for [xyz]label functions. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	22 ## @deftypefnx {Function File} {@var{h} =} xlabel (@dots{})
c715816f4539 Add additional calling form to docstring for [xyz]label functions. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	23 ## @deftypefnx {Function File} {} ylabel (@dots{})
c715816f4539 Add additional calling form to docstring for [xyz]label functions. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	24 ## @deftypefnx {Function File} {} zlabel (@dots{})
c715816f4539 Add additional calling form to docstring for [xyz]label functions. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	25 ## Specify x-, y-, or z-axis labels for the current axis. If @var{h} is
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13800 diff changeset	26 ## specified then label the axis defined by @var{h}.
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13800 diff changeset	27 ##
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13800 diff changeset	28 ## The optional return value @var{h} is a graphics handle to the created object.
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13800 diff changeset	29 ## @seealso{title, text}
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 2847 diff changeset	30 ## @end deftypefn
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	31
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	32 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	33
7215 dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe] jwe parents: 7208 diff changeset	34 function retval = xlabel (varargin)
4529 78954aeaf321 [project @ 2003-10-04 19:35:36 by jwe] jwe parents: 3979 diff changeset	35
7215 dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe] jwe parents: 7208 diff changeset	36 [h, varargin, nargin] = __plt_get_axis_arg__ ("xlabel", varargin{:});
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe] jwe parents: 7208 diff changeset	37
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe] jwe parents: 7208 diff changeset	38 if (rem (nargin, 2) != 1)
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe] jwe parents: 7208 diff changeset	39 print_usage ();
7194 a927a2871a93 [project @ 2007-11-26 23:06:12 by jwe] jwe parents: 7017 diff changeset	40 endif
a927a2871a93 [project @ 2007-11-26 23:06:12 by jwe] jwe parents: 7017 diff changeset	41
13800 5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	42 tmp = __axis_label__ (h, "xlabel", varargin{:},
5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	43 "color", get (h, "xcolor"));
7215 dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe] jwe parents: 7208 diff changeset	44
7194 a927a2871a93 [project @ 2007-11-26 23:06:12 by jwe] jwe parents: 7017 diff changeset	45 if (nargout > 0)
7425 fe4a43e1d1d3 [project @ 2008-01-28 09:13:01 by jwe] jwe parents: 7271 diff changeset	46 retval = tmp;
4529 78954aeaf321 [project @ 2003-10-04 19:35:36 by jwe] jwe parents: 3979 diff changeset	47 endif
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	48
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	49 endfunction
13136 79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11598 diff changeset	50
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13800 diff changeset	51
13136 79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11598 diff changeset	52 %!test
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11598 diff changeset	53 %! 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	54 %! unwind_protect
13136 79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11598 diff changeset	55 %! x = xlabel ("xlabel_string");
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13800 diff changeset	56 %! assert (get (gca, "xlabel"), x);
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13800 diff changeset	57 %! assert (get (x, "type"), "text");
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13800 diff changeset	58 %! assert (get (x, "visible"), "on");
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13800 diff changeset	59 %! assert (get (x, "string"), "xlabel_string");
13136 79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11598 diff changeset	60 %! unwind_protect_cleanup
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11598 diff changeset	61 %! close (hf);
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11598 diff changeset	62 %! 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	63

Mercurial > hg > octave-nkf

annotate scripts/plot/xlabel.m @ 14552:86854d032a37