Mercurial > octave-nkf
changeset 19103:efd5cf93013b
doc: Move validatestrings into function chapter of manual.
* func.txi: Add validatestrings to function chapter dealing with processing function
inputs.
* strings.txi: Remove validatestrings from strings chapter.
* validateattributes.m: Update seealso cross reference list.
* validatestring.m: Update seealso cross reference list.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 01 Sep 2014 11:46:46 -0700 |
| parents | be8a12acb20a |
| children | aa4f762ad7d5 |
| files | doc/interpreter/func.txi doc/interpreter/strings.txi scripts/general/validateattributes.m scripts/strings/validatestring.m |
| diffstat | 4 files changed, 13 insertions(+), 8 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/func.txi Mon Sep 01 10:57:29 2014 -0700 +++ b/doc/interpreter/func.txi Mon Sep 01 11:46:46 2014 -0700 @@ -393,8 +393,6 @@ which stops the function execution and prints a message about the correct way to call the function whenever the number of inputs is wrong. -@DOCSTRING(validateattributes) - For compatibility with @sc{matlab}, @code{narginchk} and @code{nargoutchk} are available which provide similar error checking. @@ -402,8 +400,17 @@ @DOCSTRING(nargoutchk) -There is also the class @code{inputParser} which can perform extremely -complex input checking for functions. +Besides the number of arguments, inputs can be checked for various properties. +@code{validatestring} is used for string arguments and +@code{validateattributes} for numeric arguments. + +@DOCSTRING(validatestring) + +@DOCSTRING(validateattributes) + +If none of the preceding functions is sufficient there is also the class +@code{inputParser} which can perform extremely complex input checking for +functions. @DOCSTRING(inputParser)
--- a/doc/interpreter/strings.txi Mon Sep 01 10:57:29 2014 -0700 +++ b/doc/interpreter/strings.txi Mon Sep 01 11:46:46 2014 -0700 @@ -401,8 +401,6 @@ @DOCSTRING(strncmpi) -@DOCSTRING(validatestring) - @node Manipulating Strings @section Manipulating Strings
--- a/scripts/general/validateattributes.m Mon Sep 01 10:57:29 2014 -0700 +++ b/scripts/general/validateattributes.m Mon Sep 01 11:46:46 2014 -0700 @@ -161,7 +161,7 @@ ## ## @end table ## -## @seealso{nargin, varargin, isa, validatestring} +## @seealso{isa, validatestring, inputParser} ## @end deftypefn function validateattributes (A, cls, attr, varargin)
--- a/scripts/strings/validatestring.m Mon Sep 01 10:57:29 2014 -0700 +++ b/scripts/strings/validatestring.m Mon Sep 01 11:46:46 2014 -0700 @@ -53,7 +53,7 @@ ## @end group ## @end smallexample ## -## @seealso{strcmp, strcmpi} +## @seealso{strcmp, strcmpi, validateattributes, inputParser} ## @end deftypefn ## Author: Bill Denney <bill@denney.ws>