[Octave-bug-tracker] [bug #65220] get_help_text returns docstring from parent methods

[John W. Eaton]

Follow-up Comment #15, bug#65220 (group octave):

OK, I mistyped the "help foobar_class.meth" command, but I'm assuming that it
will return the "comment inside method" text given the other results.

Also, I see that properties *can* be documented in the classdef file, so I'll
look at fixing that.  I'm not sure whether we are attaching any comment info
to the property objects but it should be fairly straightforward to do that.

What happens if you remove the "%% comment prior to classdef keyword" comment
from the file?  Does Matlab find the one inside the classdef block instead?

Regarding the comment


Of course, in Octave it is necessary that get_help_text looks for texinfo
before the function because AFAIK all core functions and in many packages as
well follow this template, i.e. the help docstring is right before the
function declaration.


That is true for functions defined in separate files, but for classdef blocks,
I don't think we need to attempt to do anything more than what Matlab does. 
Let's not complicate things further.



    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?65220>

_______________________________________________
Message sent via Savannah
https://savannah.gnu.org/