changeset 20895:7697a3433e37

doc: Remove class of function from docstring from generated C++ files. * mk-opts.pl, lex.ll, oct-parse.in.yy: Remove class of function from @deftypefn.
author Rik <rik@octave.org>
date Mon, 14 Dec 2015 14:22:57 -0800
parents e528d7ab1cad
children 5e16d687a701
files build-aux/mk-opts.pl libinterp/parse-tree/lex.ll libinterp/parse-tree/oct-parse.in.yy
diffstat 3 files changed, 26 insertions(+), 26 deletions(-) [+]
line wrap: on
line diff
--- a/build-aux/mk-opts.pl	Mon Dec 14 14:16:19 2015 -0800
+++ b/build-aux/mk-opts.pl	Mon Dec 14 14:22:57 2015 -0800
@@ -907,9 +907,9 @@
   print <<"_END_EMIT_OPTIONS_FUNCTION_HDR_";
 DEFUN ($OPT_FCN_NAME, args, ,
   "-*- texinfo -*-\\n\\
-\@deftypefn  {Built-in Function} {} $OPT_FCN_NAME ()\\n\\
-\@deftypefnx {Built-in Function} {val =} $OPT_FCN_NAME (\@var{opt})\\n\\
-\@deftypefnx {Built-in Function} {} $OPT_FCN_NAME (\@var{opt}, \@var{val})\\n\\
+\@deftypefn  {} {} $OPT_FCN_NAME ()\\n\\
+\@deftypefnx {} {val =} $OPT_FCN_NAME (\@var{opt})\\n\\
+\@deftypefnx {} {} $OPT_FCN_NAME (\@var{opt}, \@var{val})\\n\\
 $DOC_STRING\\n\\
 \\n\\
 Options include\\n\\
--- a/libinterp/parse-tree/lex.ll	Mon Dec 14 14:16:19 2015 -0800
+++ b/libinterp/parse-tree/lex.ll	Mon Dec 14 14:22:57 2015 -0800
@@ -1902,8 +1902,8 @@
 
 DEFUN (iskeyword, args, ,
   "-*- texinfo -*-\n\
-@deftypefn  {Built-in Function} {} iskeyword ()\n\
-@deftypefnx {Built-in Function} {} iskeyword (@var{name})\n\
+@deftypefn  {} {} iskeyword ()\n\
+@deftypefnx {} {} iskeyword (@var{name})\n\
 Return true if @var{name} is an Octave keyword.\n\
 \n\
 If @var{name} is omitted, return a list of keywords.\n\
@@ -1962,7 +1962,7 @@
 
 DEFUN (__display_tokens__, args, nargout,
   "-*- texinfo -*-\n\
-@deftypefn {Built-in Function} {} __display_tokens__ ()\n\
+@deftypefn {} {} __display_tokens__ ()\n\
 Query or set the internal variable that determines whether Octave's\n\
 lexer displays tokens as they are read.\n\
 @seealso{__lexer_debug_flag__, __token_count__}\n\
@@ -1973,7 +1973,7 @@
 
 DEFUN (__token_count__, , ,
   "-*- texinfo -*-\n\
-@deftypefn {Built-in Function} {} __token_count__ ()\n\
+@deftypefn {} {} __token_count__ ()\n\
 Return the number of language tokens processed since Octave startup.\n\
 @seealso{__lexer_debug_flag__, __display_tokens__}\n\
 @end deftypefn")
@@ -1983,8 +1983,8 @@
 
 DEFUN (__lexer_debug_flag__, args, nargout,
   "-*- texinfo -*-\n\
-@deftypefn  {Built-in Function} {@var{val} =} __lexer_debug_flag__ ()\n\
-@deftypefnx {Built-in Function} {@var{old_val} =} __lexer_debug_flag__ (@var{new_val})\n\
+@deftypefn  {} {@var{val} =} __lexer_debug_flag__ ()\n\
+@deftypefnx {} {@var{old_val} =} __lexer_debug_flag__ (@var{new_val})\n\
 Query or set the internal flag that determines whether Octave's lexer prints\n\
 debug information as it processes an expression.\n\
 @seealso{__display_tokens__, __token_count__, __parse_debug_flag__}\n\
--- a/libinterp/parse-tree/oct-parse.in.yy	Mon Dec 14 14:16:19 2015 -0800
+++ b/libinterp/parse-tree/oct-parse.in.yy	Mon Dec 14 14:22:57 2015 -0800
@@ -4313,9 +4313,9 @@
 
 DEFUN (autoload, args, ,
   "-*- texinfo -*-\n\
-@deftypefn  {Built-in Function} {@var{autoload_map} =} autoload ()\n\
-@deftypefnx {Built-in Function} {} autoload (@var{function}, @var{file})\n\
-@deftypefnx {Built-in Function} {} autoload (@dots{}, \"remove\")\n\
+@deftypefn  {} {@var{autoload_map} =} autoload ()\n\
+@deftypefnx {} {} autoload (@var{function}, @var{file})\n\
+@deftypefnx {} {} autoload (@dots{}, \"remove\")\n\
 Define @var{function} to autoload from @var{file}.\n\
 \n\
 The second argument, @var{file}, should be an absolute filename or a file\n\
@@ -4536,9 +4536,9 @@
 
 DEFUN (mfilename, args, ,
   "-*- texinfo -*-\n\
-@deftypefn  {Built-in Function} {} mfilename ()\n\
-@deftypefnx {Built-in Function} {} mfilename (\"fullpath\")\n\
-@deftypefnx {Built-in Function} {} mfilename (\"fullpathext\")\n\
+@deftypefn  {} {} mfilename ()\n\
+@deftypefnx {} {} mfilename (\"fullpath\")\n\
+@deftypefnx {} {} mfilename (\"fullpathext\")\n\
 Return the name of the currently executing file.\n\
 \n\
 When called from outside an m-file return the empty string.\n\
@@ -4597,7 +4597,7 @@
 
 DEFUN (source, args, ,
   "-*- texinfo -*-\n\
-@deftypefn {Built-in Function} {} source (@var{file})\n\
+@deftypefn {} {} source (@var{file})\n\
 Parse and execute the contents of @var{file}.\n\
 \n\
 This is equivalent to executing commands from a script file, but without\n\
@@ -4711,7 +4711,7 @@
 
 DEFUN (feval, args, nargout,
   "-*- texinfo -*-\n\
-@deftypefn {Built-in Function} {} feval (@var{name}, @dots{})\n\
+@deftypefn {} {} feval (@var{name}, @dots{})\n\
 Evaluate the function named @var{name}.\n\
 \n\
 Any arguments after the first are passed as inputs to the named function.\n\
@@ -4757,7 +4757,7 @@
 
 DEFUN (builtin, args, nargout,
   "-*- texinfo -*-\n\
-@deftypefn {Built-in Function} {[@dots{}] =} builtin (@var{f}, @dots{})\n\
+@deftypefn {} {[@dots{}] =} builtin (@var{f}, @dots{})\n\
 Call the base function @var{f} even if @var{f} is overloaded to another\n\
 function for the given type signature.\n\
 \n\
@@ -4900,8 +4900,8 @@
 
 DEFUN (eval, args, nargout,
   "-*- texinfo -*-\n\
-@deftypefn  {Built-in Function} {} eval (@var{try})\n\
-@deftypefnx {Built-in Function} {} eval (@var{try}, @var{catch})\n\
+@deftypefn  {} {} eval (@var{try})\n\
+@deftypefnx {} {} eval (@var{try}, @var{catch})\n\
 Parse the string @var{try} and evaluate it as if it were an Octave\n\
 program.\n\
 \n\
@@ -5035,7 +5035,7 @@
 
 DEFUN (assignin, args, ,
   "-*- texinfo -*-\n\
-@deftypefn {Built-in Function} {} assignin (@var{context}, @var{varname}, @var{value})\n\
+@deftypefn {} {} assignin (@var{context}, @var{varname}, @var{value})\n\
 Assign @var{value} to @var{varname} in context @var{context}, which\n\
 may be either @qcode{\"base\"} or @qcode{\"caller\"}.\n\
 @seealso{evalin}\n\
@@ -5071,8 +5071,8 @@
 
 DEFUN (evalin, args, nargout,
   "-*- texinfo -*-\n\
-@deftypefn  {Built-in Function} {} evalin (@var{context}, @var{try})\n\
-@deftypefnx {Built-in Function} {} evalin (@var{context}, @var{try}, @var{catch})\n\
+@deftypefn  {} {} evalin (@var{context}, @var{try})\n\
+@deftypefnx {} {} evalin (@var{context}, @var{try}, @var{catch})\n\
 Like @code{eval}, except that the expressions are evaluated in the context\n\
 @var{context}, which may be either @qcode{\"caller\"} or @qcode{\"base\"}.\n\
 @seealso{eval, assignin}\n\
@@ -5151,8 +5151,8 @@
 
 DEFUN (__parser_debug_flag__, args, nargout,
   "-*- texinfo -*-\n\
-@deftypefn  {Built-in Function} {@var{val} =} __parser_debug_flag__ ()\n\
-@deftypefnx {Built-in Function} {@var{old_val} =} __parser_debug_flag__ (@var{new_val})\n\
+@deftypefn  {} {@var{val} =} __parser_debug_flag__ ()\n\
+@deftypefnx {} {@var{old_val} =} __parser_debug_flag__ (@var{new_val})\n\
 Query or set the internal flag that determines whether Octave's parser prints\n\
 debug information as it processes an expression.\n\
 @seealso{__lexer_debug_flag__}\n\
@@ -5172,7 +5172,7 @@
 
 DEFUN (__parse_file__, args, ,
   "-*- texinfo -*-\n\
-@deftypefn {Built-in Function} {} __parse_file__ (@var{file}, @var{verbose})\n\
+@deftypefn {} {} __parse_file__ (@var{file}, @var{verbose})\n\
 Undocumented internal function.\n\
 @end deftypefn")
 {