Mercurial > octave-nkf
annotate scripts/plot/ezpolar.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 | b0cdd60db5e5 |
| rev | line source |
|---|---|
| 11523 | 1 ## Copyright (C) 2007-2011 David Bateman |
| 7337 | 2 ## |
| 3 ## This file is part of Octave. | |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7 ## the Free Software Foundation; either version 3 of the License, or (at | |
| 8 ## your option) any later version. | |
| 9 ## | |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 15 ## You should have received a copy of the GNU General Public License | |
| 16 ## along with Octave; see the file COPYING. If not, see | |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 18 | |
| 19 ## -*- texinfo -*- | |
|
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
9245
diff
changeset
|
20 ## @deftypefn {Function File} {} ezpolar (@var{f}) |
| 7337 | 21 ## @deftypefnx {Function File} {} ezpolar (@dots{}, @var{dom}) |
| 22 ## @deftypefnx {Function File} {} ezpolar (@dots{}, @var{n}) | |
| 23 ## @deftypefnx {Function File} {} ezpolar (@var{h}, @dots{}) | |
| 24 ## @deftypefnx {Function File} {@var{h} =} ezpolar (@dots{}) | |
| 25 ## | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
7337
diff
changeset
|
26 ## Plots in polar plot defined by a function. The function @var{f} is either |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
27 ## a string, inline function or function handle with one arguments defining |
|
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
28 ## the function. By default the plot is over the domain @code{0 < @var{x} < |
|
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
29 ## 2*pi} with 60 points. |
| 7337 | 30 ## |
| 31 ## If @var{dom} is a two element vector, it represents the minimum and maximum | |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
32 ## value of both @var{t}. @var{n} is a scalar defining the number of points to |
| 7337 | 33 ## use. |
| 34 ## | |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
35 ## The optional return value @var{h} is a graphics handle to the created plot. |
| 7337 | 36 ## |
| 37 ## @example | |
| 38 ## ezpolar (@@(t) 1 + sin (t)); | |
| 39 ## @end example | |
| 40 ## | |
| 41 ## @seealso{polar, ezplot, ezsurf, ezmesh} | |
| 42 ## @end deftypefn | |
| 43 | |
| 44 function retval = ezpolar (varargin) | |
| 45 | |
| 46 [h, needusage] = __ezplot__ ("polar", varargin{:}); | |
| 47 | |
| 48 if (needusage) | |
| 49 print_usage (); | |
| 50 endif | |
| 51 | |
| 52 if (nargout > 0) | |
| 53 retval = h; | |
| 54 endif | |
| 55 endfunction | |
| 56 | |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
57 |
| 7337 | 58 %!demo |
| 59 %! ezpolar (@(t) 1 + sin (t)); | |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
60 |