Mercurial > octave-nkf

comparison scripts/strings/validatestring.m @ 14093:050bc580cb60 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Various docstring improvements before 3.6.0 release. * NEWS, aspell-octave.en.pws, intro.txi, oop.txi, testfun.txi, tips.txi, FIRfilter.m, FIRfilter_aggregation.m, polynomial.m, polynomial_superiorto.m, usejava.m, pcg.m, pcr.m, nchoosek.m, validatestring.m, assert.m, weekday.m, cellfun.cc, error.cc, strfns.cc: Various docstring improvements before 3.6.0 release.
author Rik <octave@nomad.inbox5.com>
date Wed, 21 Dec 2011 19:46:57 -0800
parents ee28bf4c3c29
children 72c96de7a403
comparison
equal deleted inserted replaced
14092:22c50cbad2ce 14093:050bc580cb60
37 ## The additional inputs @var{funcname}, @var{varname}, and @var{position} 37 ## The additional inputs @var{funcname}, @var{varname}, and @var{position}
38 ## are optional and will make any generated validation error message more 38 ## are optional and will make any generated validation error message more
39 ## specific. 39 ## specific.
40 ## 40 ##
41 ## Examples: 41 ## Examples:
42 ## @c Set example in small font to prevent overfull line
42 ## 43 ##
43 ## @example 44 ## @smallexample
44 ## @group 45 ## @group
45 ## validatestring ("r", @{"red", "green", "blue"@}) 46 ## validatestring ("r", @{"red", "green", "blue"@})
46 ## @result{} "red" 47 ## @result{} "red"
47 ## 48 ##
48 ## validatestring ("b", @{"red", "green", "blue", "black"@}) 49 ## validatestring ("b", @{"red", "green", "blue", "black"@})
49 ## @result{} error: validatestring: multiple unique matches were found for 'b': 50 ## @result{} error: validatestring: multiple unique matches were found for 'b':
50 ## blue, black 51 ## blue, black
51 ## @end group 52 ## @end group
52 ## @end example 53 ## @end smallexample
53 ##
54 ## 54 ##
55 ## @seealso{strcmp, strcmpi} 55 ## @seealso{strcmp, strcmpi}
56 ## @end deftypefn 56 ## @end deftypefn
57 57
58 ## Author: Bill Denney <bill@denney.ws> 58 ## Author: Bill Denney <bill@denney.ws>