Mercurial > octave-antonio

comparison scripts/testfun/demo.m @ 20162:2645f9ef8c88 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed specfun, special-matrix, testfun, and time script directories. * scripts/specfun/expint.m, scripts/specfun/isprime.m, scripts/specfun/legendre.m, scripts/specfun/primes.m, scripts/specfun/reallog.m, scripts/specfun/realsqrt.m, scripts/special-matrix/gallery.m, scripts/special-matrix/hadamard.m, scripts/special-matrix/hankel.m, scripts/special-matrix/hilb.m, scripts/special-matrix/invhilb.m, scripts/special-matrix/magic.m, scripts/special-matrix/pascal.m, scripts/special-matrix/rosser.m, scripts/special-matrix/toeplitz.m, scripts/special-matrix/vander.m, scripts/special-matrix/wilkinson.m, scripts/testfun/assert.m, scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/fail.m, scripts/testfun/rundemos.m, scripts/testfun/runtests.m, scripts/testfun/speed.m, scripts/time/asctime.m, scripts/time/calendar.m, scripts/time/clock.m, scripts/time/ctime.m, scripts/time/datenum.m, scripts/time/datestr.m, scripts/time/datevec.m, scripts/time/etime.m, scripts/time/is_leap_year.m, scripts/time/now.m, scripts/time/weekday.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 17:00:11 -0700
parents 4197fc428c7d
children
comparison
equal deleted inserted replaced
20160:03b9d17a2d95 20162:2645f9ef8c88
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 ##
26 ## If @var{n} is not specified, all examples are run. 27 ## If @var{n} is not specified, all examples are run.
27 ## 28 ##
28 ## The preferred location for example code blocks is embedded within the script 29 ## The preferred location for example code blocks is embedded within the script
29 ## m-file immediately following the code that it exercises. Alternatively, 30 ## m-file immediately following the code that it exercises. Alternatively,
30 ## the examples may be stored in a file with the same name but no extension 31 ## the examples may be stored in a file with the same name but no extension
59 ## @example 60 ## @example
60 ## %! input ("Press <enter> to continue: ", "s"); 61 ## %! input ("Press <enter> to continue: ", "s");
61 ## @end example 62 ## @end example
62 ## 63 ##
63 ## @noindent 64 ## @noindent
64 ## between the sections, but this usage is discouraged. Other techniques 65 ## between the sections, but this usage is discouraged. Other techniques to
65 ## to avoid multiple initialization blocks include using multiple plots 66 ## avoid multiple initialization blocks include using multiple plots with a new
66 ## with a new @code{figure} command between each plot, or using @code{subplot} 67 ## @code{figure} command between each plot, or using @code{subplot} to put
67 ## to put multiple plots in the same window. 68 ## multiple plots in the same window.
68 ## 69 ##
69 ## Finally, because @code{demo} evaluates within a function context it is 70 ## Finally, because @code{demo} evaluates within a function context it is not
70 ## not possible to define new functions within the code. Anonymous functions 71 ## possible to define new functions within the code. Anonymous functions make
71 ## make a good substitute in most instances. If function blocks 72 ## a good substitute in most instances. If function blocks @strong{must} be
72 ## @strong{must} be used then the code @code{eval (example ("function", n))} 73 ## used then the code @code{eval (example ("function", n))} will allow Octave
73 ## will allow Octave to see them. This has its own problems, however, as 74 ## to see them. This has its own problems, however, as @code{eval} only
74 ## @code{eval} only evaluates one line or statement at a time. In this case 75 ## evaluates one line or statement at a time. In this case the function
75 ## the function declaration must be wrapped with 76 ## declaration must be wrapped with @qcode{"if 1 <demo stuff> endif"} where
76 ## @qcode{"if 1 <demo stuff> endif"} where @qcode{"if"} is on the same line 77 ## @qcode{"if"} is on the same line as @qcode{"demo"}. For example:
77 ## as @qcode{"demo"}. For example:
78 ## 78 ##
79 ## @example 79 ## @example
80 ## @group 80 ## @group
81 ## %!demo if 1 81 ## %!demo if 1
82 ## %! function y = f(x) 82 ## %! function y = f(x)