MATLAB: How to create help documentation in the class files for the new class system in MATLAB 7.7 (R2008b)

MATLAB

I would like to create help documentation in the class file for the new class system (similar to the javadoc).

Best Answer

This functionality is available in MATLAB 7.7 (R2008b).

Please refer to the following link on "Create Help for Classes" in the Documentation Center:

web([docroot '/matlab/matlab_prog/create-help-for-classes.html'])

http://www.mathworks.com/help/matlab/matlab_prog/create-help-for-classes.html

Related Solutions

MATLAB: How to use the ISMETHOD function to determine if an inherited method belongs to a derived object for classes created in MATLAB R2007b or before

The ability to do use ISMETHOD on methods defined in a base class is not available in the MATLAB classes system for MATLAB R2007b and before.

This functionality has been added in the MATLAB classes system starting with R2008a.

To work around this issue in releases prior to R2008a, search the output of the METHODS function using the '-full' parameter. For example, if 'd' is an instance of the derived class, and 'theMethod' is a method defined in the base class:

method_list = methods(d, '-full');
if any(strcmp(method_list, 'theMethod'))
      disp('theMethod is defined for d');
end

MATLAB: Do I get an error after adding a method to a class in MATLAB 7.7 (R2008b)

The ability to automatically detect new functions or methods stored in separate files is not available in MATLAB 7.7 (R2008b).

To work around this issue, you have two options:

1. Declare the method signature within a methods block in the classdef block as specified in the 'Methods in Separate Files' section of the documentation found by executing the following at the MATLAB Command Prompt:

 web([docroot '/techdoc/matlab_oop/brdqinq.html#brdqipw-1'])

For example:

classdef MyClass
     methods (AttributeName = value,...)
        tdata = myfunction(obj,arg1,arg2)
...
     end % methods
...
end % classdef

2. After creating the function file, execute either of the following two commands to clear the class/function cache:

clear classes
clear functions

Best Answer

Related Solutions

MATLAB: How to use the ISMETHOD function to determine if an inherited method belongs to a derived object for classes created in MATLAB R2007b or before

MATLAB: Do I get an error after adding a method to a class in MATLAB 7.7 (R2008b)

Related Question