Mercurial > octave
diff libinterp/octave-value/ov-fcn-inline.cc @ 21966:112b20240c87
move docstrings in C++ files out of C strings and into comments
* __contourc__.cc, __dispatch__.cc, __dsearchn__.cc, __ichol__.cc,
__ilu__.cc, __lin_interpn__.cc, __luinc__.cc, __magick_read__.cc,
__pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc, betainc.cc,
bitfcns.cc, bsxfun.cc, cellfun.cc, colloc.cc, conv2.cc, daspk.cc,
dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc,
dlmread.cc, dot.cc, eig.cc, ellipj.cc, error.cc, fft.cc, fft2.cc,
fftn.cc, file-io.cc, filter.cc, find.cc, gammainc.cc, gcd.cc,
getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, graphics.cc,
hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, kron.cc,
load-path.cc, load-save.cc, lookup.cc, ls-oct-text.cc, lsode.cc,
lu.cc, mappers.cc, matrix_type.cc, max.cc, mgorth.cc, nproc.cc,
oct-hist.cc, octave-link.cc, ordschur.cc, pager.cc, pinv.cc,
pr-output.cc, profiler.cc, psi.cc, pt-jit.cc, quad.cc, quadcc.cc,
qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, sighandlers.cc,
sparse.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc,
sub2ind.cc, svd.cc, sylvester.cc, symtab.cc, syscalls.cc, sysdep.cc,
time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc,
utils.cc, variables.cc, __delaunayn__.cc, __eigs__.cc,
__fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc,
audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc,
convhulln.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc,
ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc,
ov-fcn-handle.cc, ov-fcn-inline.cc, ov-flt-re-mat.cc, ov-int16.cc,
ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.cc, ov-null-mat.cc,
ov-oncleanup.cc, ov-range.cc, ov-re-mat.cc, ov-struct.cc,
ov-typeinfo.cc, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc,
ov-usr-fcn.cc, ov.cc, octave.cc, pt-arg-list.cc, pt-binop.cc,
pt-eval.cc, pt-mat.cc, lex.ll, oct-parse.in.yy:
Docstrings are now comments instead of C strings.
* build-aux/mk-opts.pl: Emit docstrings as comments instead of C
strings.
* DASPK-opts.in, LSODE-opts.in: Don't quote " in docstring fragments.
* builtins.h: Include builtin-defun-decls.h unconditionally.
* defun.h (DEFUN, DEFUNX, DEFCONSTFUN): Simply emit declaration.
(DEFALIAS): Always expand to nothing.
* defun-dld.h: No special macro expansions for MAKE_BUILTINS.
(DEFUN_DLD): Use FORWARD_DECLARE_FUN.
(DEFUNX_DLD): Use FORWARD_DECLARE_FUNX.
* defun-int.h: No special macro expansions for MAKE_BUILTINS.
(FORWARD_DECLARE_FUN, FORWARD_DECLARE_FUNX): New macros.
(DEFINE_FUN_INSTALLER_FUN): If compiling an Octave source file, pass
"external-doc" to DEFINE_FUNX_INSTALLER_FUN.
(DEFUN_INTERNAL, DEFCONSTFUN_INTERNAL, DEFUNX_INTERNAL,
DEFALIAS_INTERNAL): Delete.
* common.mk (move_if_change_rule): New macro.
(simple_move_if_change_rule): Define using move_if_change_rule.
* find-defun-files.sh (DEFUN_PATTERN): Update. Don't transform file
name extension to ".df".
* libinterp/mk-pkg-add, gendoc.pl: Operate directly on source files.
* mkbuiltins: New argument, SRCDIR. Operate directly on source files.
* mkdefs: Delete.
* libinterp/module.mk (BUILT_SOURCES): Update list to contain only
files included in other source files.
(GENERATED_MAKE_BUILTINS_INCS, DEF_FILES): Delete.
(LIBINTERP_BUILT_DISTFILES): Include $(OPT_HANDLERS) here.
(LIBINTERP_BUILT_NODISTFILES): Not here. Remove $(ALL_DEF_FILES from
the list.
(libinterp_EXTRA_DIST): Remove mkdefs from the list.
(FOUND_DEFUN_FILES): Rename from SRC_DEF_FILES.
(DLDFCN_DEFUN_FILES): Rename from DLDFCN_DEF_FILES.
(SRC_DEFUN_FILES): Rename from SRC_DEF_FILES.
(ALL_DEFUN_FILES): Rename from ALL_DEF_FILES.
(%.df: %.cc): Delete pattern rule.
(libinterp/build-env-features.cc, libinterp/builtins.cc,
libinterp/dldfcn/PKG_ADD): Use mv instead of move-if-change.
(libinterp/builtins.cc, libinterp/builtin-defun-decls.h):
Update mkbuiltins command.
($(srcdir)/libinterp/DOCSTRINGS): Update gendoc.pl command.
* liboctave/module.mk (BUILT_SOURCES): Don't include
liboctave-build-info.cc in the list.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 21 Jun 2016 16:07:51 -0400 |
parents | c4ab2e54f100 |
children | 0f6fc2ec3b1a |
line wrap: on
line diff
--- a/libinterp/octave-value/ov-fcn-inline.cc Tue Jun 21 13:08:25 2016 -0700 +++ b/libinterp/octave-value/ov-fcn-inline.cc Tue Jun 21 16:07:51 2016 -0400 @@ -655,32 +655,32 @@ } DEFUNX ("inline", Finline, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} inline (@var{str})\n\ -@deftypefnx {} {} inline (@var{str}, @var{arg1}, @dots{})\n\ -@deftypefnx {} {} 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 function\n\ -are extracted from the function itself. The generated function arguments\n\ -will then be in alphabetical order. It should be noted that i and j are\n\ -ignored as arguments due to the ambiguity between their use as a variable or\n\ -their use as an built-in constant. All arguments followed by a parenthesis\n\ -are considered to be functions. If no arguments are found, a function\n\ -taking a single argument named @code{x} will be created.\n\ -\n\ -If the second and subsequent arguments are character strings, they are the\n\ -names of the arguments of the function.\n\ -\n\ -If the second argument is an integer @var{n}, the arguments are\n\ -@qcode{\"x\"}, @qcode{\"P1\"}, @dots{}, @qcode{\"P@var{N}\"}.\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") + doc: /* -*- texinfo -*- +@deftypefn {} {} inline (@var{str}) +@deftypefnx {} {} inline (@var{str}, @var{arg1}, @dots{}) +@deftypefnx {} {} inline (@var{str}, @var{n}) +Create an inline function from the character string @var{str}. + +If called with a single argument, the arguments of the generated function +are extracted from the function itself. The generated function arguments +will then be in alphabetical order. It should be noted that i and j are +ignored as arguments due to the ambiguity between their use as a variable or +their use as an built-in constant. All arguments followed by a parenthesis +are considered to be functions. If no arguments are found, a function +taking a single argument named @code{x} will be created. + +If the second and subsequent arguments are character strings, they are the +names of the arguments of the function. + +If the second argument is an integer @var{n}, the arguments are +@qcode{"x"}, @qcode{"P1"}, @dots{}, @qcode{"P@var{N}"}. + +Programming Note: The use of @code{inline} is discouraged and it may be +removed from a future version of Octave. The preferred way to create +functions from strings is through the use of anonymous functions +(@pxref{Anonymous Functions}) or @code{str2func}. +@seealso{argnames, formula, vectorize, str2func} +@end deftypefn */) { int nargin = args.length (); @@ -834,14 +834,14 @@ */ DEFUN (formula, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} formula (@var{fun})\n\ -Return a character string representing the inline function @var{fun}.\n\ -\n\ -Note that @code{char (@var{fun})} is equivalent to\n\ -@code{formula (@var{fun})}.\n\ -@seealso{char, argnames, inline, vectorize}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {} formula (@var{fun}) +Return a character string representing the inline function @var{fun}. + +Note that @code{char (@var{fun})} is equivalent to +@code{formula (@var{fun})}. +@seealso{char, argnames, inline, vectorize} +@end deftypefn */) { if (args.length () != 1) print_usage (); @@ -865,12 +865,12 @@ */ DEFUN (argnames, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} argnames (@var{fun})\n\ -Return a cell array of character strings containing the names of the\n\ -arguments of the inline function @var{fun}.\n\ -@seealso{inline, formula, vectorize}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {} argnames (@var{fun}) +Return a cell array of character strings containing the names of the +arguments of the inline function @var{fun}. +@seealso{inline, formula, vectorize} +@end deftypefn */) { if (args.length () != 1) print_usage (); @@ -902,24 +902,24 @@ */ DEFUN (vectorize, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} vectorize (@var{fun})\n\ -Create a vectorized version of the inline function @var{fun} by replacing\n\ -all occurrences of @code{*}, @code{/}, etc., with @code{.*}, @code{./}, etc.\n\ -\n\ -This may be useful, for example, when using inline functions with numerical\n\ -integration or optimization where a vector-valued function is expected.\n\ -\n\ -@example\n\ -@group\n\ -fcn = vectorize (inline (\"x^2 - 1\"))\n\ - @result{} fcn = f(x) = x.^2 - 1\n\ -quadv (fcn, 0, 3)\n\ - @result{} 6\n\ -@end group\n\ -@end example\n\ -@seealso{inline, formula, argnames}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {} vectorize (@var{fun}) +Create a vectorized version of the inline function @var{fun} by replacing +all occurrences of @code{*}, @code{/}, etc., with @code{.*}, @code{./}, etc. + +This may be useful, for example, when using inline functions with numerical +integration or optimization where a vector-valued function is expected. + +@example +@group +fcn = vectorize (inline ("x^2 - 1")) + @result{} fcn = f(x) = x.^2 - 1 +quadv (fcn, 0, 3) + @result{} 6 +@end group +@end example +@seealso{inline, formula, argnames} +@end deftypefn */) { if (args.length () != 1) print_usage ();