[Octave-bug-tracker] [bug #45045] documentation cache for octave packages does not include autoload functions

[Carnë Draug]

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

                 Summary: documentation cache for octave packages does not
include autoload functions
                 Project: GNU Octave
            Submitted by: carandraug
            Submitted on: Thu 07 May 2015 15:33:54 GMT
                Category: Documentation
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Incorrect Result
                  Status: None
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any
                 Release: dev
        Operating System: GNU/Linux

    _______________________________________________________

Details:

When cache for documentation for a package is created (calling
doc_cache_create), only the function named by the oct file gets his
documentation created. The end result is that `lookfor` will not use
autoloaded functions when searching the help text.

Example using the image package where searching for label should return both
bwlabel and bwlabeln:


> pkg load image
> man bwlabel
[...]
 -- Loadable Function: [L, NUM] = bwlabel( BW)
 -- Loadable Function: [L, NUM] = bwlabel( BW, N)
     Label binary 2 dimensional image.
[...]
> man bwlabeln 
[...]
 -- Loadable Function: [L, NUM] = bwlabeln (BW)
 -- Loadable Function: [L, NUM] = bwlabeln (BW, N)
     Label foreground objects in the n-dimensional binary image BW.
[...]
> lookfor label
clabel              Add labels to the contours of a contour plot.
datetick            Add date formatted tick labels to an axis.
legend              Display a legend for the current axes using the specified
strings  as labels.
xlabel              Specify the string used to label the x-axis of the current
axis.
ylabel              Specify the string used to label the y-axis of the current
axis.
zlabel              Specify the string used to label the z-axis of the current
axis.
label2rgb           Convert labeled image into RGB.
labelmatrix         Create labelled matrix from bwconncomp structure.
bwlabeln            Label foreground objects in the n-dimensional binary image
BW.


Kudos to Olaf Till for finding this issue.




    _______________________________________________________

Reply to this item at:

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

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