Mercurial > octave
comparison scripts/testfun/example.m @ 14359:7277fe922e99
doc: Use Octave preference for double quote in docstrings in scripts/
* interp1.m, interp2.m, interp3.m, interpn.m, profexplore.m, profile.m,
profshow.m, quadgk.m, lookfor.m, imagesc.m, bzip2.m, gzip.m, parseparams.m,
pkg.m, ancestor.m, caxis.m, ezmesh.m, ezmeshc.m, ezsurf.m, ezsurfc.m, hidden.m,
hold.m, patch.m, pie.m, pie3.m, quiver.m, quiver3.m, scatter3.m,
uicontextmenu.m, uicontrol.m, uipanel.m, uipushtool.m, uitoggletool.m,
uitoolbar.m, xlim.m, ylim.m, zlim.m, ismember.m, setxor.m, filter2.m, bicg.m,
demo.m, example.m, fail.m, test.m: Use Octave preference for double quote in
docstrings in scripts/ directory.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 13 Feb 2012 07:38:23 -0800 |
parents | 11949c9795a0 |
children | f3d52523cde1 |
comparison
equal
deleted
inserted
replaced
14358:adb352685ded | 14359:7277fe922e99 |
---|---|
17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
18 | 18 |
19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
20 ## @deftypefn {Command} {} example @var{name} | 20 ## @deftypefn {Command} {} example @var{name} |
21 ## @deftypefnx {Command} {} example @var{name} @var{n} | 21 ## @deftypefnx {Command} {} example @var{name} @var{n} |
22 ## @deftypefnx {Function File} {} example ('@var{name}') | 22 ## @deftypefnx {Function File} {} example ("@var{name}") |
23 ## @deftypefnx {Function File} {} example ('@var{name}', @var{n}) | 23 ## @deftypefnx {Function File} {} example ("@var{name}", @var{n}) |
24 ## @deftypefnx {Function File} {[@var{s}, @var{idx}] =} example (@dots{}) | 24 ## @deftypefnx {Function File} {[@var{s}, @var{idx}] =} example (@dots{}) |
25 ## | 25 ## |
26 ## Display the code for example @var{n} associated with the function | 26 ## Display the code for example @var{n} associated with the function |
27 ## '@var{name}', but do not run it. If @var{n} is not specified, all examples | 27 ## "@var{name}", but do not run it. If @var{n} is not specified, all examples |
28 ## are displayed. | 28 ## are displayed. |
29 ## | 29 ## |
30 ## When called with output arguments, the examples are returned in the form of | 30 ## When called with output arguments, the examples are returned in the form of |
31 ## a string @var{s}, with @var{idx} indicating the ending position of the | 31 ## a string @var{s}, with @var{idx} indicating the ending position of the |
32 ## various examples. | 32 ## various examples. |