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

annotate scripts/plot/title.m @ 14245:4506eade9f04

Use Matlab coding conventions for demos in plot/ directory. * contrast.m, axis.m, clabel.m, colorbar.m, comet.m, contour.m, contour3.m, cylinder.m, daspect.m, errorbar.m, ezplot.m, fplot.m, grid.m, hold.m, isosurface.m, legend.m, loglog.m, loglogerr.m, pareto.m, patch.m, pbaspect.m, pie.m, pie3.m, plot3.m, plotmatrix.m, plotyy.m, quiver.m, quiver3.m, rectangle.m, refreshdata.m, scatter.m, scatter3.m, semilogx.m, semilogxerr.m, semilogy.m, semilogyerr.m, shading.m, stem.m, subplot.m, text.m, title.m, trimesh.m, triplot.m, trisurf.m, uigetdir.m, uigetfile.m, uimenu.m, uiputfile.m, waitbar.m, xlim.m, ylim.m, zlim.m: Use Matlab coding conventions for demos so that compare plots scripts will function.

author	Rik <octave@nomad.inbox5.com>
date	Sun, 22 Jan 2012 07:31:32 -0800
parents	11949c9795a0
children	f3d52523cde1

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: 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{})
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13812 diff changeset	24 ## Create a title object for a plot.
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13812 diff changeset	25 ##
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13812 diff changeset	26 ## The optional return value @var{h} is a graphics handle to the created object.
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 2847 diff changeset	27 ## @end deftypefn
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	28
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	29 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	30
13812 d3f0d75faf2c title: avoid spurious output John W. Eaton <jwe@octave.org> parents: 13800 diff changeset	31 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	32
5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	33 [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	34
13800 5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	35 if (rem (nargin, 2) != 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5775 diff changeset	36 print_usage ();
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	37 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	38
13800 5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	39 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	40
5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	41 if (nargout > 0)
5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	42 retval = tmp;
5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	43 endif
5acb5c25e4ae allow axes handle to be passed to title function John W. Eaton <jwe@octave.org> parents: 13141 diff changeset	44
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	45 endfunction
13089 87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	46
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13812 diff changeset	47
13089 87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	48 %!demo
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	49 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	50 %! ax = axes ();
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	51 %! xl = get (ax,'title');
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	52 %! title ('Testing title');
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	53 %! assert (get (xl, 'string'), 'Testing title');
13089 87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	54
87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	55 %!demo
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	56 %! clf;
13089 87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	57 %! plot3 ([0,1], [0,1], [0,1]);
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	58 %! xl = get (gca (), 'title');
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	59 %! title ('Testing title');
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	60 %! assert (get (xl, 'string'), 'Testing title');
13089 87015276d625 codesprint: demos for title John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	61
13136 79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	62 %!test
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	63 %! 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	64 %! unwind_protect
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13812 diff changeset	65 %! ax = axes();
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13812 diff changeset	66 %! xl = get (ax,"title");
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13812 diff changeset	67 %! title ("Testing title");
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	68 %! assert (get (xl, "string"), "Testing title");
13136 79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	69 %! unwind_protect_cleanup
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	70 %! close (hf);
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	71 %! end_unwind_protect
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	72
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	73 %!test
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	74 %! 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	75 %! unwind_protect
13136 79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	76 %! plot3 ([0,1], [0,1], [0,1]);
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13812 diff changeset	77 %! xl = get (gca (), "title");
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	78 %! title ("Testing title");
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	79 %! assert (get (xl, "string"), "Testing title");
13136 79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	80 %! unwind_protect_cleanup
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	81 %! close (hf);
79b9a7669bb8 Tests added for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 13089 diff changeset	82 %! end_unwind_protect
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13812 diff changeset	83

Mercurial > hg > octave-lyh

annotate scripts/plot/title.m @ 14245:4506eade9f04