Mercurial > octave-antonio

comparison scripts/miscellaneous/genvarname.m @ 20164:df437a52bcaf 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 miscellaneous, sparse, strings in scripts directory. * scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m, scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m, scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m, scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m, scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m, scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m, scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m, scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m, scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m, scripts/sparse/treeplot.m, scripts/strings/base2dec.m, scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m, scripts/strings/isletter.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m, scripts/strings/strjoin.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/strings/untabify.m, scripts/time/datenum.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Mon, 04 May 2015 14:22:02 -0700
parents 9fc020886ae9
children
comparison
equal deleted inserted replaced
20163:075a5e2e1ba5 20164:df437a52bcaf
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {@var{varname} =} genvarname (@var{str}) 20 ## @deftypefn {Function File} {@var{varname} =} genvarname (@var{str})
21 ## @deftypefnx {Function File} {@var{varname} =} genvarname (@var{str}, @var{exclusions}) 21 ## @deftypefnx {Function File} {@var{varname} =} genvarname (@var{str}, @var{exclusions})
22 ## Create valid unique variable name(s) from @var{str}. 22 ## Create valid unique variable name(s) from @var{str}.
23 ## 23 ##
24 ## If @var{str} is a cellstr, then a unique variable is created for each 24 ## If @var{str} is a cellstr, then a unique variable is created for each cell
25 ## cell in @var{str}. 25 ## in @var{str}.
26 ## 26 ##
27 ## @example 27 ## @example
28 ## @group 28 ## @group
29 ## genvarname (@{"foo", "foo"@}) 29 ## genvarname (@{"foo", "foo"@})
30 ## @result{} 30 ## @result{}
34 ## @} 34 ## @}
35 ## @end group 35 ## @end group
36 ## @end example 36 ## @end example
37 ## 37 ##
38 ## If @var{exclusions} is given, then the variable(s) will be unique to each 38 ## If @var{exclusions} is given, then the variable(s) will be unique to each
39 ## other and to @var{exclusions} (@var{exclusions} may be either a string or 39 ## other and to @var{exclusions} (@var{exclusions} may be either a string or a
40 ## a cellstr). 40 ## cellstr).
41 ## 41 ##
42 ## @example 42 ## @example
43 ## @group 43 ## @group
44 ## x = 3.141; 44 ## x = 3.141;
45 ## genvarname ("x", who ()) 45 ## genvarname ("x", who ())
46 ## @result{} x1 46 ## @result{} x1
47 ## @end group 47 ## @end group
48 ## @end example 48 ## @end example
49 ## 49 ##
50 ## Note that the result is a char array or cell array of strings, not the 50 ## Note that the result is a char array or cell array of strings, not the
51 ## variables themselves. To define a variable, @code{eval()} can be 51 ## variables themselves. To define a variable, @code{eval()} can be used.
52 ## used. The following trivial example sets @code{x} to @code{42}. 52 ## The following trivial example sets @code{x} to @code{42}.
53 ## 53 ##
54 ## @example 54 ## @example
55 ## @group 55 ## @group
56 ## name = genvarname ("x"); 56 ## name = genvarname ("x");
57 ## eval ([name " = 42"]); 57 ## eval ([name " = 42"]);
76 ## @end group 76 ## @end group
77 ## @end example 77 ## @end example
78 ## 78 ##
79 ## Since variable names may only contain letters, digits, and underscores, 79 ## Since variable names may only contain letters, digits, and underscores,
80 ## @code{genvarname} will replace any sequence of disallowed characters with 80 ## @code{genvarname} will replace any sequence of disallowed characters with
81 ## an underscore. Also, variables may not begin with a digit; in this 81 ## an underscore. Also, variables may not begin with a digit; in this case
82 ## case an @samp{x} is added before the variable name. 82 ## an @samp{x} is added before the variable name.
83 ## 83 ##
84 ## Variable names beginning and ending with two underscores @qcode{"__"} are 84 ## Variable names beginning and ending with two underscores @qcode{"__"} are
85 ## valid, but they are used internally by Octave and should generally be 85 ## valid, but they are used internally by Octave and should generally be
86 ## avoided; therefore, @code{genvarname} will not generate such names. 86 ## avoided; therefore, @code{genvarname} will not generate such names.
87 ## 87 ##