Mercurial > octave-nkf
diff libinterp/octave-value/ov-fcn-inline.cc @ 20198:075a5e2e1ba5 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed build-aux, libinterp/dldfcn, libinterp/octave-value,
libinterp/parse-tree directories.
* build-aux/mk-opts.pl, libinterp/dldfcn/__magick_read__.cc,
libinterp/dldfcn/amd.cc, libinterp/dldfcn/audiodevinfo.cc,
libinterp/dldfcn/audioread.cc, libinterp/dldfcn/ccolamd.cc,
libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc,
libinterp/dldfcn/convhulln.cc, libinterp/dldfcn/dmperm.cc,
libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc,
libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc,
libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-oncleanup.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc,
libinterp/octave-value/ov.cc, libinterp/parse-tree/lex.ll,
libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc,
libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc:
doc: Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 21:52:42 -0700 |
parents | 17d647821d61 |
children | a9574e3c6e9e |
line wrap: on
line diff
--- a/libinterp/octave-value/ov-fcn-inline.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/octave-value/ov-fcn-inline.cc Sun May 03 21:52:42 2015 -0700 @@ -654,17 +654,16 @@ @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\ -be noted that i, and j are ignored as arguments due to the\n\ -ambiguity between their use as a variable or their use as an inbuilt\n\ -constant. All arguments followed by a parenthesis are considered\n\ -to be functions. If no arguments are found, a function taking a single\n\ -argument named @code{x} will be created.\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,\n\ -they are the names of the arguments of the function.\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\ @@ -904,8 +903,8 @@ DEFUN (argnames, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} argnames (@var{fun})\n\ -Return a cell array of character strings containing the names of\n\ -the arguments of the inline function @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") { @@ -951,13 +950,11 @@ DEFUN (vectorize, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} vectorize (@var{fun})\n\ -Create a vectorized version of the inline function @var{fun}\n\ -by replacing all occurrences of @code{*}, @code{/}, etc., with\n\ -@code{.*}, @code{./}, etc.\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\n\ -numerical integration or optimization where a vector-valued function\n\ -is expected.\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\