Mercurial > hg > octave-nkf
diff scripts/plot/xlabel.m @ 14001:5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
* voronoi.m, image.m, imagesc.m, imshow.m, area.m, bar.m, barh.m, clabel.m,
clf.m, compass.m, ezcontour.m, ezcontourf.m, ezmesh.m, ezmeshc.m, ezplot.m,
ezplot3.m, ezpolar.m, ezsurf.m, ezsurfc.m, feather.m, fill.m, findall.m,
findobj.m, loglog.m, mesh.m, pareto.m, patch.m, pie.m, pie3.m, plot.m, polar.m,
quiver.m, quiver3.m, rectangle.m, ribbon.m, rose.m, scatter.m, scatter3.m,
semilogx.m, semilogy.m, slice.m, stem.m, surf.m, surface.m, text.m, title.m,
trimesh.m, triplot.m, trisurf.m, xlabel.m, ylabel.m, zlabel.m:
Update documentation for functions returning a graphics handle h.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Tue, 06 Dec 2011 13:09:17 -0800 |
| parents | 5acb5c25e4ae |
| children | 72c96de7a403 |
line wrap: on
line diff
--- a/scripts/plot/xlabel.m +++ b/scripts/plot/xlabel.m @@ -23,10 +23,10 @@ ## @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} +## specified then label the axis defined by @var{h}. +## +## The optional return value @var{h} is a graphics handle to the created object. +## @seealso{title, text} ## @end deftypefn ## Author: jwe @@ -48,14 +48,16 @@ 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"); +%! 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 +