Mercurial > hg > octave-lyh
view scripts/plot/gtext.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 27 Mar 2009 22:31:03 -0700 |
parents | dbd0c77e575e |
children | 16f53d29049f |
line wrap: on
line source
## Copyright (C) 2008 David Bateman ## ## 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} {} gtext (@var{s}) ## @deftypefnx {Function File} {} gtext (@dots{}, @var{prop}, @var{val}) ## Place text on the current figure. The text can be defined by the ## string @var{s}. If @var{s} is a cell array, each element of the cell ## array is written to a separate line. ## ## Additional arguments are passed to the underlying text object as ## properties. ## @seealso{ginput} ## @end deftypefn function gtext (s, varargin) if (nargin > 0) if (iscellstr (s)) if (isempty (s)) s = ""; else s = sprintf ("%s\n", s{:}); endif endif if (ischar (s)) if (! isempty (s)) [x, y] = ginput (1); text (x, y, s, varargin{:}); endif else error ("gtext: expecting a string or cell array of strings"); endif else print_usage (); endif endfunction