Mercurial > octave-nkf
diff libinterp/octave-value/ov-fcn-handle.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 | bd9d34f28b0f |
children | f958e8cd6348 |
line wrap: on
line diff
--- a/libinterp/octave-value/ov-fcn-handle.cc Fri Feb 28 16:55:26 2014 -0800 +++ b/libinterp/octave-value/ov-fcn-handle.cc Sat Mar 01 21:50:13 2014 -0800 @@ -1659,9 +1659,49 @@ DEFUN (functions, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} functions (@var{fcn_handle})\n\ -Return a struct containing information about the function handle\n\ +@deftypefn {Built-in Function} {@var{s} =} functions (@var{fcn_handle})\n\ +Return a structure containing information about the function handle\n\ @var{fcn_handle}.\n\ +\n\ +The structure @var{s} always contains these 3 fields:\n\ +\n\ +@table @asis\n\ +@item function\n\ +The function name. For an anonymous function (no name) this will be the\n\ +actual function definition.\n\ +\n\ +@item type\n\ +Type of the function.\n\ +\n\ +@table @asis\n\ +@item anonymous\n\ +The function is anonymous.\n\ +\n\ +@item private\n\ +The function is private.\n\ +\n\ +@item overloaded\n\ +The function overloads an existing function.\n\ +\n\ +@item simple\n\ +The function is a built-in or m-file function.\n\ +\n\ +@item subfunction\n\ +The function is a subfunction within an m-file.\n\ +@end table\n\ +\n\ +@item file\n\ +The m-file that will be called to perform the function. This field is empty\n\ +for anonymous and built-in functions.\n\ +@end table\n\ +\n\ +In addition, some function types may return more information in additional\n\ +fields.\n\ +\n\ +@strong{Warning:} @code{functions} is provided for debugging purposes only.\n\ +It's behavior may change in the future and programs should not depend on a\n\ +particular output.\n\ +\n\ @end deftypefn") { octave_value retval; @@ -1760,6 +1800,7 @@ @deftypefn {Built-in Function} {} func2str (@var{fcn_handle})\n\ Return a string containing the name of the function referenced by\n\ the function handle @var{fcn_handle}.\n\ +@seealso{str2func, functions}\n\ @end deftypefn") { octave_value retval; @@ -1799,6 +1840,7 @@ Return a function handle constructed from the string @var{fcn_name}.\n\ If the optional @qcode{\"global\"} argument is passed, locally visible\n\ functions are ignored in the lookup.\n\ +@seealso{func2str, inline}\n\ @end deftypefn") { octave_value retval; @@ -1839,7 +1881,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} is_function_handle (@var{x})\n\ Return true if @var{x} is a function handle.\n\ -@seealso{isa, typeinfo, class}\n\ +@seealso{isa, typeinfo, class, functions}\n\ @end deftypefn") { octave_value retval;