| MATLAB Function Reference | |
As an alternative to the doc function, use the Help browser Search for field. Type the function name and click Go.
doc
doc functionname
doc toolboxname
doc toolboxname/functionname
doc classname.methodname
doc opens the Help browser, if it is not already running, or brings the window to the top, displaying the Contents pane when the Help browser is already open.
doc functionname displays the reference page for the MATLAB® function functionname in the Help browser. For example, you are looking at the reference page for the doc function. Here functionname can be a function, block, property, method, or object. If functionname is overloaded, that is, if functionname appears in multiple directories on the search path MATLAB uses, doc displays the reference page for the first functionname on the search path and displays a hyperlinked list of the other functions and their directories in the MATLAB Command Window. Overloaded functions within the same product are not listed — use the overloaddirectory form of the syntax. If a reference page for functionname does not exist, doc displays its M-file help in the Help browser. The doc function is intended only for help files supplied by The MathWorks™, and is not supported for use with HTML files you create yourself.
doc toolboxname displays the roadmap page for toolboxname in the Help browser, which provides a summary of the most pertinent documentation for that product.
doc toolboxname/functionname displays the reference page for the functionname that belongs to the specified toolboxname, in the Help browser. This is useful for overloaded functions.
doc classname.methodname displays the reference page for the methodname that is a member of classname.
Note If there is a function called name as well as a toolbox called name, the roadmap page for the toolbox called name displays. To see the reference page for the function called name, use doc toolboxname/name, where toolboxname is the name of the toolbox in which the function name resides. For example, doc matlab displays the roadmap page for MATLAB (that is, the matlab toolbox), while doc matlab/matlabunix displays the reference page for the matlab startup function for The Open Group UNIX® platforms, which is in MATLAB. |
Type doc abs to display the reference page for the abs function. If the Simulink® and Signal Processing Toolbox™ products are installed and on the search path, the Command Window lists hyperlinks for the abs function in those products:
doc signal/abs doc simulink/abs
Type doc signal/abs to display the reference page for the abs function in the Signal Processing Toolbox product.
Type doc signal to display the roadmap page for Signal Processing Toolbox product.
Type doc serial.get to display the reference page for the get method located in the serial directory of MATLAB. This syntax is required because there is at least one other get function in MATLAB.
docopt, docsearch, help, helpbrowser, lookfor, type, web
Getting Help in MATLAB® Software in the MATLAB Desktop Tools and Development Environment documentation.
| dmperm | docopt | |
| © 1984-2008- The MathWorks, Inc. - Site Help - Patents - Trademarks - Privacy Policy - Preventing Piracy - RSS |