Mercurial > octave-antonio

comparison libinterp/octave-value/ov-fcn-handle.cc @ 20163:075a5e2e1ba5 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 09ed6f7538dd
children
comparison
equal deleted inserted replaced
20162:2645f9ef8c88 20163:075a5e2e1ba5
1674 "-*- texinfo -*-\n\ 1674 "-*- texinfo -*-\n\
1675 @deftypefn {Built-in Function} {@var{s} =} functions (@var{fcn_handle})\n\ 1675 @deftypefn {Built-in Function} {@var{s} =} functions (@var{fcn_handle})\n\
1676 Return a structure containing information about the function handle\n\ 1676 Return a structure containing information about the function handle\n\
1677 @var{fcn_handle}.\n\ 1677 @var{fcn_handle}.\n\
1678 \n\ 1678 \n\
1679 The structure @var{s} always contains these 3 fields:\n\ 1679 The structure @var{s} always contains these three fields:\n\
1680 \n\ 1680 \n\
1681 @table @asis\n\ 1681 @table @asis\n\
1682 @item function\n\ 1682 @item function\n\
1683 The function name. For an anonymous function (no name) this will be the\n\ 1683 The function name. For an anonymous function (no name) this will be the\n\
1684 actual function definition.\n\ 1684 actual function definition.\n\
1809 } 1809 }
1810 1810
1811 DEFUN (func2str, args, , 1811 DEFUN (func2str, args, ,
1812 "-*- texinfo -*-\n\ 1812 "-*- texinfo -*-\n\
1813 @deftypefn {Built-in Function} {} func2str (@var{fcn_handle})\n\ 1813 @deftypefn {Built-in Function} {} func2str (@var{fcn_handle})\n\
1814 Return a string containing the name of the function referenced by\n\ 1814 Return a string containing the name of the function referenced by the\n\
1815 the function handle @var{fcn_handle}.\n\ 1815 function handle @var{fcn_handle}.\n\
1816 @seealso{str2func, functions}\n\ 1816 @seealso{str2func, functions}\n\
1817 @end deftypefn") 1817 @end deftypefn")
1818 { 1818 {
1819 octave_value retval; 1819 octave_value retval;
1820 1820
1849 DEFUN (str2func, args, , 1849 DEFUN (str2func, args, ,
1850 "-*- texinfo -*-\n\ 1850 "-*- texinfo -*-\n\
1851 @deftypefn {Built-in Function} {} str2func (@var{fcn_name})\n\ 1851 @deftypefn {Built-in Function} {} str2func (@var{fcn_name})\n\
1852 @deftypefnx {Built-in Function} {} str2func (@var{fcn_name}, \"global\")\n\ 1852 @deftypefnx {Built-in Function} {} str2func (@var{fcn_name}, \"global\")\n\
1853 Return a function handle constructed from the string @var{fcn_name}.\n\ 1853 Return a function handle constructed from the string @var{fcn_name}.\n\
1854 \n\
1854 If the optional @qcode{\"global\"} argument is passed, locally visible\n\ 1855 If the optional @qcode{\"global\"} argument is passed, locally visible\n\
1855 functions are ignored in the lookup.\n\ 1856 functions are ignored in the lookup.\n\
1856 @seealso{func2str, inline}\n\ 1857 @seealso{func2str, inline}\n\
1857 @end deftypefn") 1858 @end deftypefn")
1858 { 1859 {