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

[John W. Eaton]

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

"According to the matlab documentation [1], the function docs should be inside
the function itself."

OK, but what does Matlab actually do?

Given a classdef file that contains


%% comment prior to classdef keyword
classdef foobar_class
  %% comment inside classdef block
  methods
    %% comment prior to constructor
    function obj = foobar_class ()
      %% comment inside constructor
    end
    %% comment prior to method
    function meth (obj)
      %% comment inside method
    end
  end
  properties
    %% comment for property A
    A = 1;
  end
end


What does the following produce?


help foobar_class
help foobar_class.foobar_class
help foobar_class.method
help foobar.A


IF any of the "comment prior to ..." comments are displayed, what happens if
they are removed?

Does the behavior change if any of the "comment inside ..." comments are
removed?


    _______________________________________________________

Reply to this item at:

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

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