Products & Services Solutions Academia Support User Community Company

Learn more about MATLAB   

Getting Help for Functions and Blocks

Ways to Get Help for Functions and Blocks

When You Are Using...How to Get Help
Any desktop toolSee

Finding Functions Using the Function Browser

Help browser Contents pane
  1. Expand the listing for a product.

  2. Expand the Functions or Blocks entry to view all functions or blocks in the product.

  3. Select a function or block to view its reference page.

See Browsing for Documentation and Demos.
Help browser search
  1. Search for a function or block name.

  2. Sort results by type, and then view results for the Reference type.

  3. Select a function or block to view its reference page.

See Searching for Documentation and Demos.
Page displayed in the Help browser
  1. Select a function name on the page.

  2. Right-click, and select Help on Selection. The Help browser goes to the reference page for the selected function.

To view the code for the function, in step 2, select Open Selection. The M-file opens in the Editor.
Current Folder browserSee:

Command Window or Editor

See Getting Help for a Function Shown in the Command Window or Editor

Command WindowSee:
  • doc function to display reference page

  • help function to display brief help in the Command Window

Help for Overloaded Functions

When there is more than one function with the same name (called an overloaded function), the help features find pages for all the functions. Choose the reference page for the specific function you want.

For example, when you get help for a selected function from the Editor, the Help browser displays the reference page for the first function on the search path. At the top of the reference page is a message bar containing links to references pages for the overloaded functions.

When M-File Help Displays in the Help Browser

When a reference page for a function does not exist and M-file help for the function exists, the Help browser displays M-file help. For example, when you get help for a selected function from the Editor, M-file help could appear. It could be for an M-file provided by a user.

You can use the M-file help in the Help browser, or you can access it in the Command Window using the help function.

See Also

  


Recommended Products

Includes the most popular MATLAB recorded presentations with Q&A sessions led by MATLAB experts.

 © 1984-2009- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS