Functionality name, such as the name of a function, method, class, toolbox, or variable, specified as a character vector or string scalar. name
also can be an operator symbol (such as +
).
If name
is a variable, help
displays the help text for the class of that variable.
To get help for a method of a class, specify the class name and the method name, separated with a period. For example, to get help for the methodname
method of the classname
class, type help classname.methodname
.
Some classes and other packaged items require that you specify the package name. Events, properties, and some methods require that you specify the class name. Separate the components of the name with periods. For example, to get help for the propertyname
property of the classname
class, type classname.propertyname
. To get help for the classname
class in the packagename
package, type packagename.methodname
. To get help for the methodname
method of the classname
class in the packagename
package, type packagename.classname.methodname
.
If name
appears in multiple folders on the MATLAB search path, help
displays the help text for the first instance of name
found on the search path.
If name
is overloaded, help
displays a link to a list of the methods with the same name.
If name
specifies the name or partial path of a folder:
If the folder contains a nonempty
Contents.m
file, thehelp
function displays the file.Contents.m
contains a list of MATLAB program files in the folder and their descriptions.If the folder contains an empty
Contents.m
file, thehelp
function displays
.name
is a folderIf the folder does not contain a
Contents.m
file, thehelp
function lists the first line of help text for each program file in the folder.If
name
is the name of both a folder and another item on the MATLAB search path (such as a method, class, toolbox, or variable), thehelp
function displays the associated text for the item on the search path and a link to display the help text for the folder.