comparison src/variables.cc @ 12642:f96b9b9f141b stable

doc: Periodic grammarcheck and spellcheck of documentation. * func.txi: Correct two misspellings * cumtrapz.m, dblquad.m, quadgk.m, quadl.m, quadv.m, trapz.m, triplequad.m, cond.m, gmres.m, bzip2.m, compare_versions.m, getappdata.m, unpack.m, ver.m, glpk.m, pkg.m, axis.m, uigetdir.m, uigetfile.m, view.m, prctile.m, quantile.m, unidcdf.m, unidinv.m, isstrprop.m, balance.cc, besselj.cc, cellfun.cc, colamd.cc, dot.cc, eigs.cc, fftw.cc, matrix_type.cc, pinv.cc, qr.cc, quad.cc, quadcc.cc, qz.cc, regexp.cc, schur.cc, time.cc (gmtime), typecast.cc urlwrite.cc bitfcns.cc (bitshift), data.cc (rem, norm, merge) debug.cc (dbstatus), dirfns.cc (glob), file-io.cc (freport), load-path.cc (genpath), load-save.cc (save), mappers.cc (islower, isupper, tolower, toupper) oct-hist.cc (edit_history), ov-fcn-inline.cc (vectorize), ov.cc (subsref), syscalls.cc (stat), variables.cc (whos, clear): Improve docstrings. Removed trailing whitespace characters on line.
author Rik <octave@nomad.inbox5.com>
date Sun, 01 May 2011 11:39:50 -0700
parents 2dbac27e0e40
children 25d4e163ee38 e7b03b8662a2
comparison
equal deleted inserted replaced
12639:4d777e05d47c 12642:f96b9b9f141b
1826 The table can be customized to display more or less information through\n\ 1826 The table can be customized to display more or less information through\n\
1827 the function @code{whos_line_format}.\n\ 1827 the function @code{whos_line_format}.\n\
1828 \n\ 1828 \n\
1829 If @code{whos} is called as a function, return a struct array of defined\n\ 1829 If @code{whos} is called as a function, return a struct array of defined\n\
1830 variable names matching the given patterns. Fields in the structure\n\ 1830 variable names matching the given patterns. Fields in the structure\n\
1831 describing each variable are: name, size, bytes, class, global, sparse, \n\ 1831 describing each variable are: name, size, bytes, class, global, sparse,\n\
1832 complex, nesting, persistent.\n\ 1832 complex, nesting, persistent.\n\
1833 @seealso{who, whos_line_format}\n\ 1833 @seealso{who, whos_line_format}\n\
1834 @end deftypefn") 1834 @end deftypefn")
1835 { 1835 {
1836 octave_value retval; 1836 octave_value retval;
2261 \n\ 2261 \n\
2262 @item [ @var{list} ]\n\ 2262 @item [ @var{list} ]\n\
2263 Match the list of characters specified by @var{list}. If the first\n\ 2263 Match the list of characters specified by @var{list}. If the first\n\
2264 character is @code{!} or @code{^}, match all characters except those\n\ 2264 character is @code{!} or @code{^}, match all characters except those\n\
2265 specified by @var{list}. For example, the pattern @samp{[a-zA-Z]} will\n\ 2265 specified by @var{list}. For example, the pattern @samp{[a-zA-Z]} will\n\
2266 match all lower and upper case alphabetic characters.\n\ 2266 match all lowercase and uppercase alphabetic characters.\n\
2267 @end table\n\ 2267 @end table\n\
2268 \n\ 2268 \n\
2269 For example, the command\n\ 2269 For example, the command\n\
2270 \n\ 2270 \n\
2271 @example\n\ 2271 @example\n\
2309 \n\ 2309 \n\
2310 @item -regexp, -r\n\ 2310 @item -regexp, -r\n\
2311 The arguments are treated as regular expressions as any variables that\n\ 2311 The arguments are treated as regular expressions as any variables that\n\
2312 match will be cleared.\n\ 2312 match will be cleared.\n\
2313 @end table\n\ 2313 @end table\n\
2314 With the exception of @code{exclusive}, all long options can be used \n\ 2314 With the exception of @code{exclusive}, all long options can be used\n\
2315 without the dash as well.\n\ 2315 without the dash as well.\n\
2316 @end deftypefn") 2316 @end deftypefn")
2317 { 2317 {
2318 octave_value_list retval; 2318 octave_value_list retval;
2319 2319