Mercurial > hg > octave-nkf
comparison scripts/plot/gtext.m @ 9307:c2923c27c877
Various documentation improvements
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Sat, 06 Jun 2009 18:30:52 -0700 |
parents | 16f53d29049f |
children | 95c3e38098bf |
comparison
equal
deleted
inserted
replaced
9306:de124edcebf6 | 9307:c2923c27c877 |
---|---|
15 ## You should have received a copy of the GNU General Public License | 15 ## You should have received a copy of the GNU General Public License |
16 ## along with Octave; see the file COPYING. If not, see | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
18 | 18 |
19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
20 ## @deftypefn {Function File} {} gtext (@var{s}) | 20 ## @deftypefn {Function File} {} gtext (@var{s}) |
21 ## @deftypefnx {Function File} {} gtext (@{@var{s1}; @var{s2}; @dots{}@}) | |
21 ## @deftypefnx {Function File} {} gtext (@dots{}, @var{prop}, @var{val}) | 22 ## @deftypefnx {Function File} {} gtext (@dots{}, @var{prop}, @var{val}) |
22 ## Place text on the current figure. The text can be defined by the | 23 ## Place text on the current figure using the mouse. The text is defined |
23 ## string @var{s}. If @var{s} is a cell array, each element of the cell | 24 ## by the string @var{s}. If @var{s} is a cell array, each element of the cell |
24 ## array is written to a separate line. | 25 ## array is written to a separate line. Additional arguments are passed to |
25 ## | 26 ## the underlying text object as properties. |
26 ## Additional arguments are passed to the underlying text object as | 27 ## @seealso{ginput, text} |
27 ## properties. | |
28 ## @seealso{ginput} | |
29 ## @end deftypefn | 28 ## @end deftypefn |
30 | 29 |
31 function gtext (s, varargin) | 30 function gtext (s, varargin) |
32 | 31 |
33 if (nargin > 0) | 32 if (nargin > 0) |