Mercurial > hg > octave-nkf
diff 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 |
line wrap: on
line diff
--- a/scripts/plot/pie3.m +++ b/scripts/plot/pie3.m @@ -23,17 +23,17 @@ ## @deftypefnx {Function File} {} pie3 (@dots{}, @var{labels}) ## @deftypefnx {Function File} {} pie3 (@var{h}, @dots{}); ## @deftypefnx {Function File} {@var{h} =} pie3 (@dots{}); -## Draw a 3-D pie chart. +## Plot a 3-D pie chart. ## ## Called with a single vector argument, produces a 3-D pie chart of the -## elements in @var{x}, with the size of the slice determined by percentage -## size of the values of @var{x}. +## elements in @var{x}. The size of the ith slice is the percentage that the +## element @var{x}i represents of the total sum of @var{x}. ## -## The variable @var{explode} is a vector of the same length as @var{x} that -## if non zero "explodes" the slice from the pie chart. +## The variable @var{explode} is a vector of the same length as @var{x} that, +## if non-zero, "explodes" the slice from the pie chart. ## -## If given @var{labels} is a cell array of strings of the same length as -## @var{x}, giving the labels of each of the slices of the pie chart. +## The optional input @var{labels} is a cell array of strings of the same +## length as @var{x} specifying the label for each slice. ## ## The optional return value @var{h} is a list of graphics handles to the patch, ## surface, and text objects generating the plot.