Mercurial > hg > octave-lyh
comparison scripts/plot/rose.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 | c792872f8942 |
children | 22c50cbad2ce |
comparison
equal
deleted
inserted
replaced
14000:15400d5deb1c | 14001:5f0bb45e615c |
---|---|
28 ## | 28 ## |
29 ## If @var{r} is given and is a scalar, then the histogram is produced with | 29 ## If @var{r} is given and is a scalar, then the histogram is produced with |
30 ## @var{r} bins. If @var{r} is a vector, then the center of each bin are | 30 ## @var{r} bins. If @var{r} is a vector, then the center of each bin are |
31 ## defined by the values of @var{r}. | 31 ## defined by the values of @var{r}. |
32 ## | 32 ## |
33 ## The optional return value @var{h} provides a list of handles to the | 33 ## The optional return value @var{h} is a vector of graphics handles to the |
34 ## the parts of the vector field (body, arrow and marker). | 34 ## line objects representing each histogram. |
35 ## | 35 ## |
36 ## If two output arguments are requested, then rather than plotting the | 36 ## If two output arguments are requested then, rather than plotting the |
37 ## histogram, the polar vectors necessary to plot the histogram are | 37 ## histogram, the polar vectors necessary to plot the histogram are |
38 ## returned. | 38 ## returned. |
39 ## | 39 ## |
40 ## @example | 40 ## @example |
41 ## @group | 41 ## @group |
42 ## [r, t] = rose ([2*randn(1e5,1), pi + 2 * randn(1e5,1)]); | 42 ## [r, t] = rose ([2*randn(1e5,1), pi + 2 * randn(1e5,1)]); |
43 ## polar (r, t); | 43 ## polar (r, t); |
44 ## @end group | 44 ## @end group |
45 ## @end example | 45 ## @end example |
46 ## | 46 ## |
47 ## | 47 ## @seealso{polar, compass, hist} |
48 ## @seealso{plot, compass, polar, hist} | |
49 ## @end deftypefn | 48 ## @end deftypefn |
50 | 49 |
51 function [thout, rout] = rose (varargin) | 50 function [thout, rout] = rose (varargin) |
52 | 51 |
53 [h, varargin, nargin] = __plt_get_axis_arg__ ((nargout > 1), "rose", | 52 [h, varargin, nargin] = __plt_get_axis_arg__ ((nargout > 1), "rose", |