Mercurial > hg > octave-nkf

comparison libinterp/parse-tree/oct-parse.in.yy @ 20373: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 8aa424ffc076
children b70cc4bd8109
comparison
equal deleted inserted replaced
20372:2645f9ef8c88 20373:075a5e2e1ba5
4314 @deftypefn {Built-in Function} {@var{autoload_map} =} autoload ()\n\ 4314 @deftypefn {Built-in Function} {@var{autoload_map} =} autoload ()\n\
4315 @deftypefnx {Built-in Function} {} autoload (@var{function}, @var{file})\n\ 4315 @deftypefnx {Built-in Function} {} autoload (@var{function}, @var{file})\n\
4316 @deftypefnx {Built-in Function} {} autoload (@dots{}, \"remove\")\n\ 4316 @deftypefnx {Built-in Function} {} autoload (@dots{}, \"remove\")\n\
4317 Define @var{function} to autoload from @var{file}.\n\ 4317 Define @var{function} to autoload from @var{file}.\n\
4318 \n\ 4318 \n\
4319 The second argument, @var{file}, should be an absolute file name or\n\ 4319 The second argument, @var{file}, should be an absolute file name or a file\n\
4320 a file name in the same directory as the function or script from which\n\ 4320 name in the same directory as the function or script from which the autoload\n\
4321 the autoload command was run. @var{file} @emph{should not} depend on the\n\ 4321 command was run. @var{file} @emph{should not} depend on the Octave load\n\
4322 Octave load path.\n\ 4322 path.\n\
4323 \n\ 4323 \n\
4324 Normally, calls to @code{autoload} appear in PKG_ADD script files that\n\ 4324 Normally, calls to @code{autoload} appear in PKG_ADD script files that are\n\
4325 are evaluated when a directory is added to Octave's load path. To\n\ 4325 evaluated when a directory is added to Octave's load path. To avoid having\n\
4326 avoid having to hardcode directory names in @var{file}, if @var{file}\n\ 4326 to hardcode directory names in @var{file}, if @var{file} is in the same\n\
4327 is in the same directory as the PKG_ADD script then\n\ 4327 directory as the PKG_ADD script then\n\
4328 \n\ 4328 \n\
4329 @example\n\ 4329 @example\n\
4330 autoload (\"foo\", \"bar.oct\");\n\ 4330 autoload (\"foo\", \"bar.oct\");\n\
4331 @end example\n\ 4331 @end example\n\
4332 \n\ 4332 \n\
4541 @deftypefn {Built-in Function} {} mfilename ()\n\ 4541 @deftypefn {Built-in Function} {} mfilename ()\n\
4542 @deftypefnx {Built-in Function} {} mfilename (\"fullpath\")\n\ 4542 @deftypefnx {Built-in Function} {} mfilename (\"fullpath\")\n\
4543 @deftypefnx {Built-in Function} {} mfilename (\"fullpathext\")\n\ 4543 @deftypefnx {Built-in Function} {} mfilename (\"fullpathext\")\n\
4544 Return the name of the currently executing file.\n\ 4544 Return the name of the currently executing file.\n\
4545 \n\ 4545 \n\
4546 When called from outside an m-file return the empty string. Given the\n\ 4546 When called from outside an m-file return the empty string.\n\
4547 argument @qcode{\"fullpath\"}, include the directory part of the file name,\n\ 4547 \n\
4548 but not the extension. Given the argument @qcode{\"fullpathext\"}, include\n\ 4548 Given the argument @qcode{\"fullpath\"}, include the directory part of the\n\
4549 the directory part of the file name and the extension.\n\ 4549 file name, but not the extension.\n\
4550 \n\
4551 Given the argument @qcode{\"fullpathext\"}, include the directory part of\n\
4552 the file name and the extension.\n\
4550 @end deftypefn") 4553 @end deftypefn")
4551 { 4554 {
4552 octave_value retval; 4555 octave_value retval;
4553 4556
4554 int nargin = args.length (); 4557 int nargin = args.length ();
4730 } 4733 }
4731 4734
4732 DEFUN (feval, args, nargout, 4735 DEFUN (feval, args, nargout,
4733 "-*- texinfo -*-\n\ 4736 "-*- texinfo -*-\n\
4734 @deftypefn {Built-in Function} {} feval (@var{name}, @dots{})\n\ 4737 @deftypefn {Built-in Function} {} feval (@var{name}, @dots{})\n\
4735 Evaluate the function named @var{name}. Any arguments after the first\n\ 4738 Evaluate the function named @var{name}.\n\
4736 are passed as inputs to the named function. For example,\n\ 4739 \n\
4740 Any arguments after the first are passed as inputs to the named function.\n\
4741 For example,\n\
4737 \n\ 4742 \n\
4738 @example\n\ 4743 @example\n\
4739 @group\n\ 4744 @group\n\
4740 feval (\"acos\", -1)\n\ 4745 feval (\"acos\", -1)\n\
4741 @result{} 3.1416\n\ 4746 @result{} 3.1416\n\
4743 @end example\n\ 4748 @end example\n\
4744 \n\ 4749 \n\
4745 @noindent\n\ 4750 @noindent\n\
4746 calls the function @code{acos} with the argument @samp{-1}.\n\ 4751 calls the function @code{acos} with the argument @samp{-1}.\n\
4747 \n\ 4752 \n\
4748 The function @code{feval} can also be used with function handles of\n\ 4753 The function @code{feval} can also be used with function handles of any sort\n\
4749 any sort (@pxref{Function Handles}). Historically, @code{feval} was\n\ 4754 (@pxref{Function Handles}). Historically, @code{feval} was the only way to\n\
4750 the only way to call user-supplied functions in strings, but\n\ 4755 call user-supplied functions in strings, but function handles are now\n\
4751 function handles are now preferred due to the cleaner syntax they\n\ 4756 preferred due to the cleaner syntax they offer. For example,\n\
4752 offer. For example,\n\
4753 \n\ 4757 \n\
4754 @example\n\ 4758 @example\n\
4755 @group\n\ 4759 @group\n\
4756 @var{f} = @@exp;\n\ 4760 @var{f} = @@exp;\n\
4757 feval (@var{f}, 1)\n\ 4761 feval (@var{f}, 1)\n\
4781 } 4785 }
4782 4786
4783 DEFUN (builtin, args, nargout, 4787 DEFUN (builtin, args, nargout,
4784 "-*- texinfo -*-\n\ 4788 "-*- texinfo -*-\n\
4785 @deftypefn {Built-in Function} {[@dots{}] =} builtin (@var{f}, @dots{})\n\ 4789 @deftypefn {Built-in Function} {[@dots{}] =} builtin (@var{f}, @dots{})\n\
4786 Call the base function @var{f} even if @var{f} is overloaded to\n\ 4790 Call the base function @var{f} even if @var{f} is overloaded to another\n\
4787 another function for the given type signature.\n\ 4791 function for the given type signature.\n\
4788 \n\ 4792 \n\
4789 This is normally useful when doing object-oriented programming and there\n\ 4793 This is normally useful when doing object-oriented programming and there is\n\
4790 is a requirement to call one of Octave's base functions rather than\n\ 4794 a requirement to call one of Octave's base functions rather than the\n\
4791 the overloaded one of a new class.\n\ 4795 overloaded one of a new class.\n\
4792 \n\ 4796 \n\
4793 A trivial example which redefines the @code{sin} function to be the\n\ 4797 A trivial example which redefines the @code{sin} function to be the\n\
4794 @code{cos} function shows how @code{builtin} works.\n\ 4798 @code{cos} function shows how @code{builtin} works.\n\
4795 \n\ 4799 \n\
4796 @example\n\ 4800 @example\n\
4943 DEFUN (eval, args, nargout, 4947 DEFUN (eval, args, nargout,
4944 "-*- texinfo -*-\n\ 4948 "-*- texinfo -*-\n\
4945 @deftypefn {Built-in Function} {} eval (@var{try})\n\ 4949 @deftypefn {Built-in Function} {} eval (@var{try})\n\
4946 @deftypefnx {Built-in Function} {} eval (@var{try}, @var{catch})\n\ 4950 @deftypefnx {Built-in Function} {} eval (@var{try}, @var{catch})\n\
4947 Parse the string @var{try} and evaluate it as if it were an Octave\n\ 4951 Parse the string @var{try} and evaluate it as if it were an Octave\n\
4948 program. If that fails, evaluate the optional string @var{catch}.\n\ 4952 program.\n\
4949 The string @var{try} is evaluated in the current context,\n\ 4953 \n\
4950 so any results remain available after @code{eval} returns.\n\ 4954 If execution fails, evaluate the optional string @var{catch}.\n\
4955 \n\
4956 The string @var{try} is evaluated in the current context, so any results\n\
4957 remain available after @code{eval} returns.\n\
4951 \n\ 4958 \n\
4952 The following example creates the variable @var{A} with the approximate\n\ 4959 The following example creates the variable @var{A} with the approximate\n\
4953 value of 3.1416 in the current workspace.\n\ 4960 value of 3.1416 in the current workspace.\n\
4954 \n\ 4961 \n\
4955 @example\n\ 4962 @example\n\
5111 5118
5112 DEFUN (evalin, args, nargout, 5119 DEFUN (evalin, args, nargout,
5113 "-*- texinfo -*-\n\ 5120 "-*- texinfo -*-\n\
5114 @deftypefn {Built-in Function} {} evalin (@var{context}, @var{try})\n\ 5121 @deftypefn {Built-in Function} {} evalin (@var{context}, @var{try})\n\
5115 @deftypefnx {Built-in Function} {} evalin (@var{context}, @var{try}, @var{catch})\n\ 5122 @deftypefnx {Built-in Function} {} evalin (@var{context}, @var{try}, @var{catch})\n\
5116 Like @code{eval}, except that the expressions are evaluated in the\n\ 5123 Like @code{eval}, except that the expressions are evaluated in the context\n\
5117 context @var{context}, which may be either @qcode{\"caller\"} or\n\ 5124 @var{context}, which may be either @qcode{\"caller\"} or @qcode{\"base\"}.\n\
5118 @qcode{\"base\"}.\n\
5119 @seealso{eval, assignin}\n\ 5125 @seealso{eval, assignin}\n\
5120 @end deftypefn") 5126 @end deftypefn")
5121 { 5127 {
5122 octave_value_list retval; 5128 octave_value_list retval;
5123 5129