diff libinterp/octave-value/ov-fcn-inline.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 870f3e12e163
children f958e8cd6348
line wrap: on
line diff
--- a/libinterp/octave-value/ov-fcn-inline.cc	Fri Feb 28 16:55:26 2014 -0800
+++ b/libinterp/octave-value/ov-fcn-inline.cc	Sat Mar 01 21:50:13 2014 -0800
@@ -639,6 +639,7 @@
 @deftypefnx {Built-in Function} {} inline (@var{str}, @var{arg1}, @dots{})\n\
 @deftypefnx {Built-in Function} {} inline (@var{str}, @var{n})\n\
 Create an inline function from the character string @var{str}.\n\
+\n\
 If called with a single argument, the arguments of the generated\n\
 function are extracted from the function itself.  The generated\n\
 function arguments will then be in alphabetical order.  It should\n\
@@ -653,7 +654,12 @@
 \n\
 If the second argument is an integer @var{n}, the arguments are\n\
 @qcode{\"x\"}, @qcode{\"P1\"}, @dots{}, @qcode{\"P@var{N}\"}.\n\
-@seealso{argnames, formula, vectorize}\n\
+\n\
+Programming Note: The use of @code{inline} is discouraged and it may be\n\
+removed from a future version of Octave.  The preferred way to create\n\
+functions from strings is through the use of anonymous functions\n\
+(@pxref{Anonymous Functions}) or @code{str2func}.\n\
+@seealso{argnames, formula, vectorize, str2func}\n\
 @end deftypefn")
 {
   octave_value retval;