Cannot generate method documentation for abstract class

Question

Daniele Lupo 2024-5-8

0
链接

此问题的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/2116477-cannot-generate-method-documentation-for-abstract-class

评论： Steven Lord 2024-5-10

I've the following abstract class:

classdef (Abstract) SessionManager < handle
  % SESSIONMANAGER Interface for a generic session manager.
  % The session manager has the responsibility to manage the sessions that
  % are opened for the system. It also allows to perform some operation on
  % them.
  methods
    b = isSessionOpened(this)
    % ISSESSIONOPENED Tells if a session is currently opened in the system.
    session = getCurrentSession(this)
    % The comment for getting current session
    loadSession(this, session)
    % another comment
    clearSession(this)
    % You know what's this
  end
end

When I try to retrieve the help of the class, I can see the description from the command line:

help SessionManager

But when I click on the link for seeing the documentation page. I cannot see the documentation for methods, they are blank:

This is what I see when I click on a link of a custom method:

What I'm doing wrong? How can I document properly the methods?

0 个评论
显示 -2更早的评论隐藏 -2更早的评论

请先登录，再进行评论。

请先登录，再回答此问题。

Answer 1

Animesh 2024-5-8

0
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/2116477-cannot-generate-method-documentation-for-abstract-class#answer_1454467

在 MATLAB Online 中打开

Hey @Daniele Lupo

This seems to be an issue with the way you have declared your functions. The functions should be declared in the following format to generate proper help documentation:

function b = isSessionOpened(this) 
    % ISSESSIONOPENED Tells if a session is currently opened in the system. 
end 

You can refer the following MathWorks documentation for more information:

https://www.mathworks.com/help/releases/R2022b/matlab/matlab_prog/create-help-for-classes.html

Hope this helps in resolving the issue.

4 个评论
显示 2更早的评论隐藏 2更早的评论

Daniele Lupo 2024-5-10

Thanks, it seems to work. But I don't understand why I need to mark as abstract the methods section if the class is abstract itself... I need to check the documentation.

thanks again.

Steven Lord 2024-5-10

You can have non-Abstract methods in an Abstract class.

In addition, if your class is defined in an @ directory specifying the method attribute Abstract can help MATLAB distinguish whether those methods are Abstract or defined in a separate file.

请先登录，再进行评论。