Mercurial > jwe > octave

comparison libinterp/octave-value/ov-usr-fcn.cc @ 21162:5a02590028c6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update docstring for nargin. * ov-usr-fcn.cc (Fnargin): Update docstring.
author Rik <rik@octave.org>
date Sat, 30 Jan 2016 21:34:51 -0800
parents e39e05d90788
children 8bec8855e9ce
comparison
equal deleted inserted replaced
21161:4c54a269ad44 21162:5a02590028c6
788 \n\ 788 \n\
789 Called from within a function, return the number of arguments passed to the\n\ 789 Called from within a function, return the number of arguments passed to the\n\
790 function. At the top level, return the number of command line arguments\n\ 790 function. At the top level, return the number of command line arguments\n\
791 passed to Octave.\n\ 791 passed to Octave.\n\
792 \n\ 792 \n\
793 If called with the optional argument @var{fcn}---a function name or handle---\n\ 793 If called with the optional argument @var{fcn}---a function name or\n\
794 return the declared number of arguments that the function can accept.\n\ 794 handle---return the declared number of arguments that the function can\n\
795 accept.\n\
795 \n\ 796 \n\
796 If the last argument to @var{fcn} is @var{varargin} the returned value is\n\ 797 If the last argument to @var{fcn} is @var{varargin} the returned value is\n\
797 negative. For example, the function @code{union} for sets is declared as\n\ 798 negative. For example, the function @code{union} for sets is declared as\n\
798 \n\ 799 \n\
799 @example\n\ 800 @example\n\
805 nargin (\"union\")\n\ 806 nargin (\"union\")\n\
806 @result{} -3\n\ 807 @result{} -3\n\
807 @end group\n\ 808 @end group\n\
808 @end example\n\ 809 @end example\n\
809 \n\ 810 \n\
810 Programming Note: @code{nargin} does not work on built-in functions.\n\ 811 Programming Note: @code{nargin} does not work on compiled functions\n\
812 (@file{.oct} files) such as built-in or dynamically loaded functions.\n\
811 @seealso{nargout, narginchk, varargin, inputname}\n\ 813 @seealso{nargout, narginchk, varargin, inputname}\n\
812 @end deftypefn") 814 @end deftypefn")
813 { 815 {
814 int nargin = args.length (); 816 int nargin = args.length ();
815 817