Mercurial > octave-nkf
comparison doc/interpreter/var.txi @ 17097:e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Correctly use @xref, @pxref, @ref macros in documentation.
* doc/interpreter/arith.txi, doc/interpreter/basics.txi,
doc/interpreter/container.txi, doc/interpreter/debug.txi,
doc/interpreter/diagperm.txi, doc/interpreter/eval.txi,
doc/interpreter/external.txi, doc/interpreter/func.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/intro.txi, doc/interpreter/java.txi,
doc/interpreter/matrix.txi, doc/interpreter/munge-texi.pl,
doc/interpreter/numbers.txi, doc/interpreter/package.txi,
doc/interpreter/plot.txi, doc/interpreter/sparse.txi,
doc/interpreter/stats.txi, doc/interpreter/strings.txi,
doc/interpreter/system.txi, doc/interpreter/var.txi,
doc/interpreter/vectorize.txi, libinterp/corefcn/error.cc,
libinterp/corefcn/qz.cc, libinterp/corefcn/regexp.cc,
scripts/general/accumarray.m, scripts/general/structfun.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/setfield.m,
scripts/miscellaneous/warning_ids.m, scripts/optimization/fminbnd.m,
scripts/optimization/fzero.m, scripts/optimization/lsqnonneg.m:
Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Correctly use @xref, @pxref, @ref macros in documentation.
* scripts/plot/line.m: Remove extra ')' in @deftypefn.
* libgui/src/qtinfo/parser.cc(find_ref): Change doc anchor search pattern to
XREF.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 27 Jul 2013 10:49:21 -0700 |
parents | 7eff3032d144 |
children | f2a8592b8fbd |
comparison
equal
deleted
inserted
replaced
17096:33037eddecd2 | 17097:e7a059a9a644 |
---|---|
47 @code{A} are distinct variables. | 47 @code{A} are distinct variables. |
48 | 48 |
49 A variable name is a valid expression by itself. It represents the | 49 A variable name is a valid expression by itself. It represents the |
50 variable's current value. Variables are given new values with | 50 variable's current value. Variables are given new values with |
51 @dfn{assignment operators} and @dfn{increment operators}. | 51 @dfn{assignment operators} and @dfn{increment operators}. |
52 @xref{Assignment Ops, ,Assignment Expressions}. | 52 @xref{Assignment Ops,,Assignment Expressions}. |
53 | 53 |
54 There is one built-in variable with a special meaning. The @code{ans} variable | 54 There is one built-in variable with a special meaning. The @code{ans} variable |
55 always contains the result of the last computation, where the output wasn't | 55 always contains the result of the last computation, where the output wasn't |
56 assigned to any variable. The code @code{a = cos (pi)} will assign the value -1 | 56 assigned to any variable. The code @code{a = cos (pi)} will assign the value -1 |
57 to the variable @code{a}, but will not change the value of @code{ans}. However, | 57 to the variable @code{a}, but will not change the value of @code{ans}. However, |
176 @node Persistent Variables | 176 @node Persistent Variables |
177 @section Persistent Variables | 177 @section Persistent Variables |
178 @cindex persistent variables | 178 @cindex persistent variables |
179 @cindex @code{persistent} statement | 179 @cindex @code{persistent} statement |
180 @cindex variables, persistent | 180 @cindex variables, persistent |
181 @anchor{docXpersistent} | 181 @anchor{XREFpersistent} |
182 | 182 |
183 A variable that has been declared @dfn{persistent} within a function | 183 A variable that has been declared @dfn{persistent} within a function |
184 will retain its contents in memory between subsequent calls to the | 184 will retain its contents in memory between subsequent calls to the |
185 same function. The difference between persistent variables and global | 185 same function. The difference between persistent variables and global |
186 variables is that persistent variables are local in scope to a | 186 variables is that persistent variables are local in scope to a |
297 function containing the variable is removed. Note that if the function | 297 function containing the variable is removed. Note that if the function |
298 definition is typed directly into the Octave prompt, the persistent | 298 definition is typed directly into the Octave prompt, the persistent |
299 variable will be cleared by a simple @code{clear} command as the entire | 299 variable will be cleared by a simple @code{clear} command as the entire |
300 function definition will be removed from memory. If you do not want | 300 function definition will be removed from memory. If you do not want |
301 a persistent variable to be removed from memory even if the function is | 301 a persistent variable to be removed from memory even if the function is |
302 cleared, you should use the @code{mlock} function as described in | 302 cleared, you should use the @code{mlock} function |
303 @xref{Function Locking}. | 303 (@pxref{Function Locking}). |
304 | 304 |
305 @node Status of Variables | 305 @node Status of Variables |
306 @section Status of Variables | 306 @section Status of Variables |
307 | 307 |
308 When creating simple one-shot programs it can be very convenient to | 308 When creating simple one-shot programs it can be very convenient to |