[Octave-bug-tracker] [bug #53416] small patch for @deftypefn

[anonymous]

URL:
  <http://savannah.gnu.org/bugs/?53416>

                 Summary: small patch for @deftypefn
                 Project: GNU Octave
            Submitted by: None
            Submitted on: Thu 22 Mar 2018 03:55:13 AM UTC
                Category: Documentation
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Documentation
                  Status: None
             Assigned to: None
         Originator Name: 
        Originator Email: address@hidden
             Open/Closed: Open
         Discussion Lock: Any
                 Release: 4.2.2
        Operating System: Any

    _______________________________________________________

Details:

Some built-in docstring miss a "="


diff -ur a/libinterp/corefcn/graphics.cc b/libinterp/corefcn/graphics.cc
--- a/libinterp/corefcn/graphics.cc
+++ b/libinterp/corefcn/graphics.cc
@@ -11545,7 +11545,7 @@
 
 DEFUN (__image_pixel_size__, args, ,
        doc: /* -*- texinfo -*-
address@hidden {} address@hidden, @var{py}} __image_pixel_size__ (@var{h})
address@hidden {} address@hidden =} __image_pixel_size__ (@var{h})
 Internal function: returns the pixel size of the image in normalized units.
 @end deftypefn */)
 {
diff -ur a/libinterp/corefcn/symtab.cc b/libinterp/corefcn/symtab.cc
--- a/libinterp/corefcn/symtab.cc
+++ b/libinterp/corefcn/symtab.cc
@@ -640,7 +640,7 @@
 
 DEFMETHOD (__current_scope__, interp, , ,
            doc: /* -*- texinfo -*-
address@hidden {} address@hidden, @var{context}]} __current_scope__ ()
address@hidden {} address@hidden, @var{context}] =} __current_scope__ ()
 Return the current scope and context as integers.
 @seealso{__dump_symtab_info__}
 @end deftypefn */)
diff -ur a/libinterp/dldfcn/audiodevinfo.cc
b/libinterp/dldfcn/audiodevinfo.cc
--- a/libinterp/dldfcn/audiodevinfo.cc
+++ b/libinterp/dldfcn/audiodevinfo.cc
@@ -1881,7 +1881,7 @@
 
 DEFUN_DLD (__recorder_getaudiodata__, args, ,
            doc: /* -*- texinfo -*-
address@hidden {} address@hidden __recorder_getaudiodata__ (@var{recorder})
address@hidden {} address@hidden =} __recorder_getaudiodata__ (@var{recorder})
 Undocumented internal function.
 @end deftypefn */)
 {



And the following is just a suggestion for "help function", which maybe is not
proper, 
because in each @deftypefn line, the first "function" is just the keyword, but
the second "function" refers to the user-defined function name.

But I could not find which source file it is in.
I found it is not in "libinterp/parse-tree/oct-parse.in.yy".


--- a/built-in-docstrings
+++ b/built-in-docstrings
@@ -18438,9 +18438,9 @@
 function
 @c libinterp/parse-tree/oct-parse.in.yy
 -*- texinfo -*-
address@hidden  {} {} function @var{outputs} = function (@var{input}, @dots{})
address@hidden {} {} function {} function (@var{input}, @dots{})
address@hidden {} {} function @var{outputs} = function
address@hidden  {} {} function @var{outputs} = @var{function} (@var{input},
@dots{})
address@hidden {} {} function {} @var{function} (@var{input}, @dots{})
address@hidden {} {} function @var{outputs} = @var{function}
 Begin a function body with @var{outputs} as results and @var{inputs} as
 parameters.
 @seealso{return}





    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?53416>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/