octave-lyh: scripts/plot/title.m annotate

annotate scripts/plot/title.m @ 13812:d3f0d75faf2c

title: avoid spurious output * title.m: Rename output argument to retval from h.

author	John W. Eaton <jwe@octave.org>
date	Fri, 04 Nov 2011 04:55:40 -0400
parents	5acb5c25e4ae
children	5f0bb45e615c

rev	line source
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11469 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
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 2847 diff changeset	19 ## -- texinfo --
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	20 ## @deftypefn {Function File} {} title (@var{string})
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	21 ## @deftypefnx {Function File} {} title (@var{string}, @var{p1}, @var{v1}, @dots{})
13800 5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	22 ## @deftypefnx {Function File} {} title (@var{h}, @dots{})
5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	23 ## @deftypefnx {Function File} {@var{h} =} title (@dots{})
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6046 diff changeset	24 ## Create a title object and return a handle to it.
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 2847 diff changeset	25 ## @end deftypefn
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	26
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	27 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	28
13812 d3f0d75faf2c title: avoid spurious output John W. Eaton <jwe@octave.org> parents: 13800 diff changeset	29 function retval = title (varargin)
13800 5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	30
5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	31 [h, varargin, nargin] = __plt_get_axis_arg__ ("title", varargin{:});
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6046 diff changeset	32
13800 5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	33 if (rem (nargin, 2) != 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5775 diff changeset	34 print_usage ();
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	35 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	36
13800 5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	37 tmp = __axis_label__ (h, "title", varargin{:});
5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	38
5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	39 if (nargout > 0)
5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	40 retval = tmp;
5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	41 endif
5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	42
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	43 endfunction
13089 87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	44
87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	45 %!demo
87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	46 %! clf ();
87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	47 %! ax=axes();
87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	48 %! xl = get(ax,"title");
87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	49 %! title("Testing title")
87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	50 %! assert(get(xl,"string"),"Testing title")
87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	51
87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	52 %!demo
87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	53 %! clf ();
87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	54 %! plot3 ([0,1], [0,1], [0,1]);
87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	55 %! xl = get(gca (), "title");
87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	56 %! title("Testing title")
87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	57 %! assert(get(xl,"string"),"Testing title")
87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	58
13136 79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	59 %!test
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	60 %! 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	61 %! unwind_protect
13136 79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	62 %! ax=axes();
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	63 %! xl = get(ax,"title");
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	64 %! title("Testing title")
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	65 %! assert(get(xl,"string"),"Testing title")
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	66 %! unwind_protect_cleanup
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	67 %! close (hf);
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	68 %! end_unwind_protect
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	69
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	70 %!test
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	71 %! 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	72 %! unwind_protect
13136 79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	73 %! plot3 ([0,1], [0,1], [0,1]);
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	74 %! xl = get(gca (), "title");
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	75 %! title("Testing title")
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	76 %! assert(get(xl,"string"),"Testing title")
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	77 %! unwind_protect_cleanup
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	78 %! close (hf);
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	79 %! end_unwind_protect

Mercurial > hg > octave-lyh

annotate scripts/plot/title.m @ 13812:d3f0d75faf2c