Hello Yasen
You can provide help text for a function or class by doing the following:
1) Below the class or function definition line (i.e. below the lines containing the "classdef" or "function" declarations), add a line with "%%" followed by a space, and write your help text there 2) If you would like to spread the help text over multiple lines, you could add "%" lines below (followed by space), and they will be shown in the description of the class or function.
The following link should give you a better idea of how to go about this:
For your quick reference, I have created a dummy class called testClass (whether it is a handle class or not does not matter), with a property and function, and some dummy comments:
classdef testClass < handle
%%Test class
% More information about test class
properties
% Some value is stored in this property
testProperty
end
methods
function check()
%%This is a function that does so and so
% It also does something else..
disp('Hello');
end
end
end
The help text can be accessed by running:
>> help testClass
Test class
More information about test class
Reference page for testClass
>> help testClass.testProperty
Some value is stored in this property
>> help testClass.check
This is a function that does so and so
It also does something else..
Sincerely
Suraj Mankulangara
