Mercurial > hg > octave-nkf
annotate scripts/plot/isprop.m @ 17122:eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
* doc/interpreter/plot.txi: Add @findex entries that were in xlim.m
* scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m,
scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m,
scripts/plot/axes.m, scripts/plot/axis.m, scripts/plot/bar.m,
scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m,
scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m,
scripts/plot/close.m, scripts/plot/closereq.m, scripts/plot/colorbar.m,
scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m,
scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m,
scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m,
scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m,
scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m,
scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m,
scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m,
scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m,
scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m,
scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m,
scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m,
scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m,
scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m,
scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m,
scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m,
scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m,
scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m,
scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m,
scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m,
scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m,
scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m,
scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m,
scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m,
scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m,
scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m,
scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m,
scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m,
scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m,
scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m,
scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m,
scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m,
scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m,
scripts/plot/zlim.m: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
| author | Rik <rik@octave.org> |
|---|---|
| date | Wed, 31 Jul 2013 13:53:30 -0700 |
| parents | 5d3a684236b0 |
| children | 278ef6bd821d |
| rev | line source |
|---|---|
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
13214
diff
changeset
|
1 ## Copyright (C) 2010-2012 Ben Abbott |
| 11374 | 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 -*- | |
|
11431
0d9640d755b1
Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents:
11374
diff
changeset
|
20 ## @deftypefn {Function File} {@var{res} =} isprop (@var{h}, @var{prop}) |
|
0d9640d755b1
Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents:
11374
diff
changeset
|
21 ## Return true if @var{prop} is a property of the object with handle @var{h}. |
| 11374 | 22 ## @seealso{get, set} |
| 23 ## @end deftypefn | |
| 24 | |
| 25 ## Author: Ben Abbott <bpabbott@mac.com> | |
| 26 | |
| 27 function res = isprop (h, prop) | |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
14868
diff
changeset
|
28 |
| 11374 | 29 if (nargin < 1 || nargin > 2) |
| 30 print_usage (); | |
| 31 endif | |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
32 |
|
13214
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
33 if (! all (ishandle (h))) |
| 11374 | 34 error ("isprop: first input argument must be a handle"); |
| 35 elseif (! ischar (prop)) | |
| 36 error ("isprop: second input argument must be string"); | |
| 37 endif | |
| 38 | |
|
13214
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
39 res = false (size (h)); |
|
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
40 for n = 1:numel (res) |
|
13214
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
41 res(n) = true; |
|
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
42 try |
|
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
43 v = get (h(n), prop); |
|
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
44 catch |
|
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
45 res(n) = false; |
|
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
46 end_try_catch |
|
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
47 endfor |
| 11374 | 48 endfunction |
| 49 | |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
50 |
| 11374 | 51 %!assert (isprop (0, "foobar"), false) |
| 52 %!assert (isprop (0, "screenpixelsperinch"), true) | |
|
13214
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
53 %!assert (isprop (zeros (2, 3), "visible"), true (2, 3)) |
|
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
54 |