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

[Andreas Bertsatos]

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

In Octave, the help text below the classdef argument is parsed as the help
text of the constructor. So if there is help just before the constructor it is
ignored.
For example

classdef Foo
## help classdef
  properties
  ...
  end properties
  methods
    ## help constructor
    function this = Foo (this)
    ...
    endfunction
    ...
  endmethods
endclassdef

Does MATLAB distinguish between help classdef help text and constructor help
text? For example

help Foo
  help classdef

help Foo.Foo
  help constructor

Even if this is not supported in MATLAB, I think it would be very convenient
to have this feature in Octave, since we could have a help docstring for the
classdef itself informing about properties and methods available in the
classdef, and then have a separate help docstring about how to use the
constructor including available Name/Value paired arguments etc.


    _______________________________________________________

Reply to this item at:

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

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