Mercurial > hg > octave-lyh
view scripts/plot/xlabel.m @ 13929:9cae456085c2
Grammarcheck of documentation before 3.6.0 release.
* accumarray.m, blkdiag.m, nargoutchk.m, nthargout.m, profexplore.m, profile.m,
computer.m, orderfields.m, recycle.m, version.m, sqp.m, matlabroot.m,
__plt_get_axis_arg__.m, isonormals.m, isosurface.m, __fltk_file_filter__.m,
__is_function__.m, __uigetdir_fltk__.m, __uigetfile_fltk__.m,
__uiobject_split_args__.m, __uiputfile_fltk__.m, uicontextmenu.m, uiresume.m,
uiwait.m, mkpp.m, ppder.m, residue.m, addpref.m, getpref.m, ispref.m,
loadprefs.m, prefsfile.m, saveprefs.m, rmpref.m, setpref.m, fftshift.m, bicg.m,
bicgstab.m, cgs.m, gmres.m, __sprand_impl__.m, quantile.m, deblank.m,
strsplit.m, addtodate.m, bsxfun.cc, kron.cc, regexp.cc, data.cc, file-io.cc,
graphics.cc, load-save.cc, mappers.cc: Grammarcheck of documentation
before 3.6.0 release.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Wed, 23 Nov 2011 08:38:19 -0800 |
parents | 5acb5c25e4ae |
children | 5f0bb45e615c |
line wrap: on
line source
## Copyright (C) 1993-2011 John W. Eaton ## ## 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} {} xlabel (@var{string}) ## @deftypefnx {Function File} {} xlabel (@var{h}, @var{string}) ## @deftypefnx {Function File} {@var{h} =} xlabel (@dots{}) ## @deftypefnx {Function File} {} ylabel (@dots{}) ## @deftypefnx {Function File} {} zlabel (@dots{}) ## Specify x-, y-, or z-axis labels for the current axis. If @var{h} is ## specified then label the axis defined by @var{h}. The optional return ## value @var{h} provides a handle to the created label. ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, ## bar, stairs, title} ## @end deftypefn ## Author: jwe function retval = xlabel (varargin) [h, varargin, nargin] = __plt_get_axis_arg__ ("xlabel", varargin{:}); if (rem (nargin, 2) != 1) print_usage (); endif tmp = __axis_label__ (h, "xlabel", varargin{:}, "color", get (h, "xcolor")); if (nargout > 0) retval = tmp; endif endfunction %!test %! hf = figure ("visible", "off"); %! unwind_protect %! x = xlabel ("xlabel_string"); %! assert (get(gca, "xlabel"), x); %! assert (get(x, "type"), "text"); %! assert (get(x, "visible"), "on"); %! assert (get(x, "string"), "xlabel_string"); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect