Mercurial > octave-dspies
diff libinterp/octave-value/ov-usr-fcn.cc @ 18533:ea0d4dea1a17 stable
doc: Update documentation for functions in octave-value dir.
* ov-bool-mat.cc (Flogical): Document that input must be numeric.
Document incompatibility with Matlab regarding complex inputs.
* ov-cell.cc (Fcell): Add seealso references.
* ov-cell.cc (Fcellstr): Document that trailing spaces are trimmed.
Add seealso references.
* ov-cell.cc (Fstruct2cell): Use lowercase names in @var references.
* ov-class.cc (Fismethod): Add seealso reference to isprop.
* ov-class.cc (Fsuperiorto): Add seealso reference to inferiorto.
* ov-class.cc (Finferiorto): Add seealso reference to superiorto.
* ov-fcn-handle.cc (Ffunctions): Add table to documentation describing return
values.
* ov-fcn-handle.cc (Ffunc2str): Add seealso links to str2func, functions.
* ov-fcn-handle.cc (Fstr2func): Add seealso links to func2str, inline.
* ov-fcn-handle.cc (Fis_function_handle): Add seealso links to functions.
* ov-fcn-inline.cc (Finline): Add note that the use of inline is discouraged.
Add seealso link to str2func.
* ov-int16.cc (Fint16): Add seealso links to docstring.
* ov-int32.cc (Fint32): Add seealso links to docstring.
* ov-int64.cc (Fint64): Add seealso links to docstring.
* ov-int8.cc (Fint8): Add seealso links to docstring.
* ov-oncleanup.cc (FonCleanup): clarify docstring by using "function" rather
than "action" for what gets called when onCleanup object is destroyed.
* ov-struct.cc (Fstruct): Add additional calling forms. Add seealso links.
* ov-struct.cc (Fisfield): Add additional calling forms. Add seealso link.
* ov-struct.cc (Fnfields): Add seealso link.
* ov-struct.cc (Fcell2struct): Add additional calling forms. Add seealso link.
* ov-struct.cc (Frmfield): Emphasize that a copy of the struct is returned.
Add seealso link.
* ov-struct.cc (Fstruct_levels_to_print): Add seealso link to
print_struct_array_contents.
* ov-struct.cc (Fprint_struct_array_contents): Add seealso link to
struct_levels_to_print.
* ov-typeinfo.cc (Ftypeinfo): Add seealso links to class, isa.
* ov-uint16.cc (Fuint16): Add seealso links to docstring.
* ov-uint32.cc (Fuint32): Add seealso links to docstring.
* ov-uint64.cc (Fuint64): Add seealso links to docstring.
* ov-uint8.cc (Fuint8): Add seealso links to docstring.
* ov-usr-fcn.cc (Fnargin): Add example based on 'union' function.
* ov-usr-fcn.cc (Fnargout): Add example based on 'imread' function.
* ov-usr-fcn.cc (Foptimize_subsasgn_calls): Improve docstring.
* ov.cc (Fsubsref): Rephrase one sentence.
* fieldnames.m: Add more functions to seealso links.
* getfield.m: Re-order seealso links.
* setfield.m: Re-order seealso links.
* isprop.m Add ismethod, isobject to seealso links.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 01 Mar 2014 21:50:13 -0800 |
parents | 175b392e91fe |
children | f958e8cd6348 e3fca7930c1e |
line wrap: on
line diff
--- a/libinterp/octave-value/ov-usr-fcn.cc Fri Feb 28 16:55:26 2014 -0800 +++ b/libinterp/octave-value/ov-usr-fcn.cc Sat Mar 01 21:50:13 2014 -0800 @@ -794,10 +794,24 @@ At the top level, return the number of command line arguments passed to\n\ Octave.\n\ \n\ -If called with the optional argument @var{fcn}, a function name or handle,\n\ +If called with the optional argument @var{fcn}---a function name or handle---\n\ return the declared number of arguments that the function can accept.\n\ -If the last argument is @var{varargin} the returned value is negative.\n\ -This feature does not work on builtin functions.\n\ +\n\ +If the last argument to @var{fcn} is @var{varargin} the returned value is\n\ +negative. For example, the function @code{union} for sets is declared as\n\ +\n\ +@example\n\ +@group\n\ +function [y, ia, ib] = union (a, b, varargin)\n\ +\n\ +and\n\ +\n\ +nargin (\"union\")\n\ +@result{} -3\n\ +@end group\n\ +@end example\n\ +\n\ +Programming Note: @code{nargin} does not work on built-in functions.\n\ @seealso{nargout, varargin, isargout, varargout, nthargout}\n\ @end deftypefn") { @@ -858,8 +872,8 @@ @deftypefn {Built-in Function} {} nargout ()\n\ @deftypefnx {Built-in Function} {} nargout (@var{fcn})\n\ Within a function, return the number of values the caller expects to\n\ -receive. If called with the optional argument @var{fcn}, a function\n\ -name or handle, return the number of declared output values that the\n\ +receive. If called with the optional argument @var{fcn}---a function\n\ +name or handle---return the number of declared output values that the\n\ function can produce. If the final output argument is @var{varargout}\n\ the returned value is negative.\n\ \n\ @@ -877,8 +891,7 @@ @end example\n\ \n\ @noindent\n\ -will cause @code{nargout} to return 2 inside the function\n\ -@code{f}.\n\ +will cause @code{nargout} to return 2 inside the function @code{f}.\n\ \n\ In the second usage,\n\ \n\ @@ -890,15 +903,16 @@ will return 2, because @code{histc} has two outputs, whereas\n\ \n\ @example\n\ -nargout (@@deal)\n\ +nargout (@@imread)\n\ @end example\n\ \n\ @noindent\n\ -will return -1, because @code{deal} has a variable number of outputs.\n\ +will return -2, because @code{imread} has two outputs and the second is\n\ +@var{varargout}.\n\ \n\ -At the top level, @code{nargout} with no argument is undefined.\n\ -@code{nargout} does not work on builtin functions.\n\ -@code{nargout} returns -1 for all anonymous functions.\n\ +At the top level, @code{nargout} with no argument is undefined and will\n\ +produce an error. @code{nargout} does not work for built-in functions and\n\ +returns -1 for all anonymous functions.\n\ @seealso{nargin, varargin, isargout, varargout, nthargout}\n\ @end deftypefn") { @@ -986,8 +1000,9 @@ @deftypefnx {Built-in Function} {@var{old_val} =} optimize_subsasgn_calls (@var{new_val})\n\ @deftypefnx {Built-in Function} {} optimize_subsasgn_calls (@var{new_val}, \"local\")\n\ Query or set the internal flag for subsasgn method call optimizations.\n\ +\n\ If true, Octave will attempt to eliminate the redundant copying when calling\n\ -subsasgn method of a user-defined class.\n\ +the subsasgn method of a user-defined class.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ variable is changed locally for the function and any subroutines it calls. \n\ @@ -1021,7 +1036,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} isargout (@var{k})\n\ Within a function, return a logical value indicating whether the argument\n\ -@var{k} will be assigned on output to a variable. If the result is false,\n\ +@var{k} will be assigned to a variable on output. If the result is false,\n\ the argument has been ignored during the function call through the use of\n\ the tilde (~) special output argument. Functions can use @code{isargout} to\n\ avoid performing unnecessary calculations for outputs which are unwanted.\n\