Mercurial > octave
diff scripts/plot/findobj.m @ 14327:4d917a6a858b stable
doc: Use Octave coding conventions in @example blocks of docstrings.
* accumarray.m, accumdim.m, bar.m, base2dec.m, bincoeff.m, bitcmp.m, bitset.m,
celldisp.m, chop.m, clabel.m, cloglog.m, colon.m, compass.m, computer.m,
contour3.m, contourc.m, corr.m, cstrcat.m, ctime.m, cylinder.m, date.m,
dec2base.m, demo.m, dir.m, dlmwrite.m, expm.m, ezcontourf.m, ezcontour.m,
ezmeshc.m, ezmesh.m, ezplot.m, ezsurfc.m, ezsurf.m, feather.m, findobj.m,
flipdim.m, fplot.m, genvarname.m, getfield.m, hankel.m, hilb.m, hist.m,
idivide.m, index.m, int2str.m, interp1.m, is_leap_year.m, ismember.m,
isocolors.m, isonormals.m, isosurface.m, kurtosis.m, legendre.m, linkprop.m,
logit.m, logm.m, __makeinfo__.m, __marching_cube__.m, median.m, mkoctfile.m,
moment.m, mpoles.m, orderfields.m, pcg.m, pcr.m, plot3.m, plotmatrix.m,
polyaffine.m, polygcd.m, poly.m, polyout.m, print.m, qp.m, quadgk.m, qzhess.m,
randi.m, rat.m, refreshdata.m, residue.m, rose.m, rot90.m, saveas.m, saveobj.m,
shiftdim.m, skewness.m, spaugment.m, spdiags.m, sqp.m, stem.m, str2num.m,
strcat.m, strjust.m, strread.m, strsplit.m, structfun.m, subplot.m,
subsindex.m, substruct.m, surfl.m, surfnorm.m, svds.m, uimenu.m, union.m,
voronoi.m, warning_ids.m, wblpdf.m: Use Octave coding conventions in
@example blocks of docstrings.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Sat, 04 Feb 2012 22:12:50 -0800 |
| parents | 72c96de7a403 |
| children | 86854d032a37 |
line wrap: on
line diff
--- a/scripts/plot/findobj.m Sat Feb 04 10:29:50 2012 -0500 +++ b/scripts/plot/findobj.m Sat Feb 04 22:12:50 2012 -0800 @@ -19,44 +19,44 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{h} =} findobj () ## @deftypefnx {Function File} {@var{h} =} findobj (@var{prop_name}, @var{prop_value}) -## @deftypefnx {Function File} {@var{h} =} findobj ('-property', @var{prop_name}) -## @deftypefnx {Function File} {@var{h} =} findobj ('-regexp', @var{prop_name}, @var{pattern}) -## @deftypefnx {Function File} {@var{h} =} findobj ('flat', @dots{}) +## @deftypefnx {Function File} {@var{h} =} findobj ("-property", @var{prop_name}) +## @deftypefnx {Function File} {@var{h} =} findobj ("-regexp", @var{prop_name}, @var{pattern}) +## @deftypefnx {Function File} {@var{h} =} findobj ("flat", @dots{}) ## @deftypefnx {Function File} {@var{h} =} findobj (@var{h}, @dots{}) -## @deftypefnx {Function File} {@var{h} =} findobj (@var{h}, '-depth', @var{d}, @dots{}) +## @deftypefnx {Function File} {@var{h} =} findobj (@var{h}, "-depth", @var{d}, @dots{}) ## Find graphics object with specified property values. The simplest form is ## ## @example -## findobj (@var{prop_name}, @var{prop_Value}) +## findobj (@var{prop_name}, @var{prop_value}) ## @end example ## ## @noindent ## which returns all of the handles to the objects with the name -## @var{prop_name} and the name @var{prop_Value}. The search can be limited +## @var{prop_name} and the name @var{prop_value}. The search can be limited ## to a particular object or set of objects and their descendants by ## passing a handle or set of handles @var{h} as the first argument to ## @code{findobj}. ## ## The depth of hierarchy of objects to which to search to can be limited -## with the '-depth' argument. To limit the number depth of the hierarchy +## with the "-depth" argument. To limit the number depth of the hierarchy ## to search to @var{d} generations of children, and example is ## ## @example -## findobj (@var{h}, '-depth', @var{d}, @var{prop_Name}, @var{prop_Value}) +## findobj (@var{h}, "-depth", @var{d}, @var{prop_name}, @var{prop_value}) ## @end example ## ## Specifying a depth @var{d} of 0, limits the search to the set of object -## passed in @var{h}. A depth @var{d} of 0 is equivalent to the '-flat' +## passed in @var{h}. A depth @var{d} of 0 is equivalent to the "-flat" ## argument. ## -## A specified logical operator may be applied to the pairs of @var{prop_Name} -## and @var{prop_Value}. The supported logical operators are '-and', '-or', -## '-xor', '-not'. +## A specified logical operator may be applied to the pairs of @var{prop_name} +## and @var{prop_value}. The supported logical operators are "-and", "-or", +## "-xor", "-not". ## ## The objects may also be matched by comparing a regular expression to the ## property values, where property values that match @code{regexp -## (@var{prop_Value}, @var{pattern})} are returned. Finally, objects may be -## matched by property name only, using the '-property' option. +## (@var{prop_value}, @var{pattern})} are returned. Finally, objects may be +## matched by property name only, using the "-property" option. ## @seealso{get, set} ## @end deftypefn