You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When a class is implementing a base class, should the comments that describe its function be located in the abstract base class? Or in the class? I think it should be the abstract base class, but will MATLAB know to search there if someone types help?
It looks like the comments should be located in the class. To verify this, I removed comments from the open function in MagNet tool, added comments to the ToolBase and did a help MagNet.open and also a help ToolBase.open.
That gave me this generic help about Matlab's inbuilt open function, and nothing from the ToolBase.
Here is what I see when I add the documentation in the MagNet tool
When a class is implementing a base class, should the comments that describe its function be located in the abstract base class? Or in the class? I think it should be the abstract base class, but will MATLAB know to search there if someone types help?
Here is an example:
https://github.com/Severson-Group/eMach/blob/58f1f70dab76cf08dfeedd5f887436c983c8d4c8/tools/ToolBase.m#L15-L18
The text was updated successfully, but these errors were encountered: