Mercurial > octave-antonio
comparison scripts/testfun/demo.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 | ce2b59a6d0e5 |
| 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} {} demo @var{name} | 20 ## @deftypefn {Command} {} demo @var{name} |
| 21 ## @deftypefnx {Command} {} demo @var{name} @var{n} | 21 ## @deftypefnx {Command} {} demo @var{name} @var{n} |
| 22 ## @deftypefnx {Function File} {} demo ('@var{name}') | 22 ## @deftypefnx {Function File} {} demo ("@var{name}") |
| 23 ## @deftypefnx {Function File} {} demo ('@var{name}', @var{n}) | 23 ## @deftypefnx {Function File} {} demo ("@var{name}", @var{n}) |
| 24 ## | 24 ## |
| 25 ## Run example code block @var{n} associated with the function @var{name}. | 25 ## Run example code block @var{n} associated with the function @var{name}. |
| 26 ## If @var{n} is not specified, all examples are run. | 26 ## If @var{n} is not specified, all examples are run. |
| 27 ## | 27 ## |
| 28 ## Examples are stored in the script file, or in a file with the same | 28 ## Examples are stored in the script file, or in a file with the same |
| 63 ## to put multiple plots in the same window. | 63 ## to put multiple plots in the same window. |
| 64 ## | 64 ## |
| 65 ## Also, because demo evaluates within a function context, you cannot | 65 ## Also, because demo evaluates within a function context, you cannot |
| 66 ## define new functions inside a demo. If you must have function blocks, | 66 ## define new functions inside a demo. If you must have function blocks, |
| 67 ## rather than just anonymous functions or inline functions, you will have to | 67 ## rather than just anonymous functions or inline functions, you will have to |
| 68 ## use @code{eval(example('function',n))} to see them. Because eval only | 68 ## use @code{eval(example("function",n))} to see them. Because eval only |
| 69 ## evaluates one line, or one statement if the statement crosses | 69 ## evaluates one line, or one statement if the statement crosses |
| 70 ## multiple lines, you must wrap your demo in "if 1 <demo stuff> endif" | 70 ## multiple lines, you must wrap your demo in "if 1 <demo stuff> endif" |
| 71 ## with the 'if' on the same line as 'demo'. For example: | 71 ## with the 'if' on the same line as 'demo'. For example: |
| 72 ## | 72 ## |
| 73 ## @example | 73 ## @example |