Mercurial > hg > octave-lyh
comparison scripts/plot/pie3.m @ 16814:64e7bb01fce2
doc: Improve documentation for 2-D plot functions
* doc/interpreter/plot.txi: Rewrite documentation around get/set.
* libinterp/interpfcn/graphics.cc(Fget, Fset): Add seealso links. Add
additional calling forms for get().
* scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/comet.m,
scripts/plot/comet3.m, scripts/plot/contour.m, scripts/plot/contour3.m,
scripts/plot/contourc.m, scripts/plot/contourf.m, scripts/plot/errorbar.m,
scripts/plot/gca.m, scripts/plot/gcf.m, scripts/plot/gco.m,
scripts/plot/ishghandle.m, scripts/plot/loglogerr.m, scripts/plot/pareto.m,
scripts/plot/pcolor.m, scripts/plot/pie.m, scripts/plot/pie3.m,
scripts/plot/plotmatrix.m, scripts/plot/plotyy.m, scripts/plot/polar.m,
scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/rose.m,
scripts/plot/scatter.m, scripts/plot/semilogxerr.m, scripts/plot/semilogyerr.m,
scripts/plot/sombrero.m, scripts/plot/stairs.m, scripts/plot/stem.m,
scripts/plot/stem3.m: Improve docstrings.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 22 Jun 2013 17:40:52 -0700 |
parents | 7277fe922e99 |
children | 84e000930ca5 |
comparison
equal
deleted
inserted
replaced
16813:81e041f5633a | 16814:64e7bb01fce2 |
---|---|
21 ## @deftypefn {Function File} {} pie3 (@var{x}) | 21 ## @deftypefn {Function File} {} pie3 (@var{x}) |
22 ## @deftypefnx {Function File} {} pie3 (@var{x}, @var{explode}) | 22 ## @deftypefnx {Function File} {} pie3 (@var{x}, @var{explode}) |
23 ## @deftypefnx {Function File} {} pie3 (@dots{}, @var{labels}) | 23 ## @deftypefnx {Function File} {} pie3 (@dots{}, @var{labels}) |
24 ## @deftypefnx {Function File} {} pie3 (@var{h}, @dots{}); | 24 ## @deftypefnx {Function File} {} pie3 (@var{h}, @dots{}); |
25 ## @deftypefnx {Function File} {@var{h} =} pie3 (@dots{}); | 25 ## @deftypefnx {Function File} {@var{h} =} pie3 (@dots{}); |
26 ## Draw a 3-D pie chart. | 26 ## Plot a 3-D pie chart. |
27 ## | 27 ## |
28 ## Called with a single vector argument, produces a 3-D pie chart of the | 28 ## Called with a single vector argument, produces a 3-D pie chart of the |
29 ## elements in @var{x}, with the size of the slice determined by percentage | 29 ## elements in @var{x}. The size of the ith slice is the percentage that the |
30 ## size of the values of @var{x}. | 30 ## element @var{x}i represents of the total sum of @var{x}. |
31 ## | 31 ## |
32 ## The variable @var{explode} is a vector of the same length as @var{x} that | 32 ## The variable @var{explode} is a vector of the same length as @var{x} that, |
33 ## if non zero "explodes" the slice from the pie chart. | 33 ## if non-zero, "explodes" the slice from the pie chart. |
34 ## | 34 ## |
35 ## If given @var{labels} is a cell array of strings of the same length as | 35 ## The optional input @var{labels} is a cell array of strings of the same |
36 ## @var{x}, giving the labels of each of the slices of the pie chart. | 36 ## length as @var{x} specifying the label for each slice. |
37 ## | 37 ## |
38 ## The optional return value @var{h} is a list of graphics handles to the patch, | 38 ## The optional return value @var{h} is a list of graphics handles to the patch, |
39 ## surface, and text objects generating the plot. | 39 ## surface, and text objects generating the plot. |
40 ## | 40 ## |
41 ## @seealso{pie, bar, stem} | 41 ## @seealso{pie, bar, stem} |