Добавил:
Upload Опубликованный материал нарушает ваши авторские права? Сообщите нам.
Вуз: Предмет: Файл:
Скачиваний:
17
Добавлен:
09.02.2015
Размер:
83.46 Кб
Скачать

Installed MathWorks product.

DOC METHODNAME displays the reference page for the method

METHODNAME. You may need to run DOC CLASSNAME and use links on the CLASSNAME reference page to view the METHODNAME reference page.

DOC CLASSNAME displays the reference page for the class CLASSNAME.

You may need to qualify CLASSNAME by including its package: DOC

PACKAGENAME.CLASSNAME.

DOC CLASSNAME.METHODNAME displays the reference page for the method METHODNAME in the class CLASSNAME. You may need to qualify

CLASSNAME by including its package: DOC PACKAGENAME.CLASSNAME.

DOC PRODUCTTOOLBOXNAME displays the documentation roadmap page for PRODUCTTOOLBOXNAME in the Help browser. PRODUCTTOOLBOXNAME is the folder name for a product in matlabroot/toolbox. To get PRODUCTTOOLBOXNAME for a product, run WHICH FUNCTIONNAME, where FUNCTIONNAME is the name of a function in that product; MATLAB returns the full path to FUNCTIONNAME, and PRODUCTTOOLBOXNAME is the folder following matlabroot/toolbox/.

DOC FOLDERNAME/FUNCTIONNAME displays the reference page for the

FUNCTIONNAME that exists in FOLDERNAME. Use this syntax to display the reference page for an overloaded function.

DOC USERCREATEDCLASSNAME displays the help comments from the

user-created class definition file, UserCreatedClassName.m, in an

HTML format in the Help browser. UserCreatedClassName.m must have a

help comment following the classdef UserCreatedClassName statement

or following the constructor method for UserCreatedClassName. To

directly view the help for any method, property, or event of

UserCreatedClassName, use dot notation, as in DOC

USERCREATEDCLASSNAME.METHODNAME.

Examples:

doc abs

doc signal/abs % ABS function in the Signal Processing Toolbox

doc handle.findobj % FINDOBJ method in the HANDLE class

doc handle % HANDLE class

doc containers.Map % Map class in the containers method

doc sads % User-created class, sads

doc sads.steer % steer method in the user-created class, sads

Reference page in Help browser

doc doc

<docsearch> - Search HTML documentation in the Help browser.

DOCSEARCH Search HTML documentation in the Help browser.

DOCSEARCH, by itself, brings up the Help browser with the Search tab

selected.

DOCSEARCH TEXT brings up the Help browser with the Search tab selected,

and executes a full-text search of the documentation on the text.

Examples:

docsearch plot

docsearch plot unix

docsearch('plot unix')

See also doc, helpbrowser.

Reference page in Help browser

doc docsearch

Accessing M-file help

<help> - M-file help, displayed at the command line.

HELP Display help text in Command Window.

HELP, by itself, lists all primary help topics. Each primary topic

corresponds to a directory name on the MATLABPATH.

HELP / lists a description of all operators and special characters.

HELP FUN displays a description of and syntax for the function FUN.

When FUN is in multiple directories on the MATLAB path, HELP displays

information about the first FUN found on the path.

HELP PATHNAME/FUN displays help for the function FUN in the PATHNAME directory. Use this syntax to get help for overloaded functions.

HELP MODELNAME.MDL displays the complete description for the MDL-file MODELNAME as defined in Model Properties > Description. If Simulink

is installed, you do not need to specify the .mdl extension.

HELP DIR displays a brief description of each function in the MATLAB

directory DIR. DIR can be a relative partial pathname (see HELP

PARTIALPATH). When there is also a function called DIR, help for both

the directory and the function are provided.

HELP CLASSNAME.METHODNAME displays help for the method METHODNAME of the fully qualified class CLASSNAME. To determine CLASSNAME for METHODNAME, use CLASS(OBJ), where METHODNAME is of the same class as the object OBJ.

HELP CLASSNAME displays help for the fully qualified class CLASSNAME.

HELP('syntax') displays help describing the syntax used in MATLAB

commands and functions.

T = HELP(TOPIC) returns the help text for TOPIC as a string, with

each line separated by \n. TOPIC is any allowable argument for HELP.

REMARKS:

1. Use MORE ON before running HELP to pause HELP output after a

screenful of text displays.

2. In the help syntax, function names are capitalized to make them

stand out. In practice, always type function names in lowercase. For

functions that are shown with mixed case (for example, javaObject)

type the mixed case as shown.

3. Use DOC FUN to display help about the function in the Help

browser, which might provide additional information, such as graphics

and more examples.

4. Use DOC HELP for information about creating help for your own

M-files.

5. Use the Help browser search field to find more information

about TOPIC or other terms.

EXAMPLES:

help close - displays help for the CLOSE function.

help database/close - displays help for the CLOSE function in the

Database Toolbox.

help database - lists all functions in the Database Toolbox and

displays help for the DATABASE function.

help general - lists all functions in the directory MATLAB/GENERAL.

help f14_dap - displays the description of the Simulink f14_dap.mdl

model file (Simulink must be installed).

t = help('close') - gets help for the function CLOSE and stores it as

a string in t.

See also doc, docsearch, helpbrowser, helpwin, lookfor, matlabpath,

more, partialpath, which, whos, class.

Overloaded methods:

cgmathsobject/help

cvtest/help

cvdata/help

fdesign.help

Reference page in Help browser

doc help

<helpwin> - M-file help, displayed in the help browser.

HELPWIN Online help displayed in the Help window

HELPWIN TOPIC displays the help text for the specified TOPIC inside the

Help window. Links are created to functions referenced in the 'See Also'

line of the help text.

HELPWIN(HELP_STR,TITLE) displays the string HELP_STR in the help

window. HELP_STR may be passed in as a string with each line separated

by carriage returns, a column vector cell array of strings with each cell

(row) representing a line or as a string matrix with each row representing

a line. The optional string TITLE will appear in the title banner.

HELPWIN({TITLE1 HELP_STR1;TITLE2 HELP_STR2;...},PAGE) displays one page of multi-page help text. Note: this calling sequence is deprecated and

is provided only for compatibility with previous versions of HELPWIN.

The multi-page help text is passed in as a cell array of strings or cells containing TITLE and HELP_STR pairs.

Each row of the multi-page help text cell array (dimensioned number of

pages by 2) consists of a title string paired with a string, cell array

or string matrix of help text. The second argument PAGE is a string

which must match one of the TITLE entries in the multi-page help text.

The matching TITLE represents the page that is to be displayed first.

If no second argument is given, the first page is displayed.

HELPWIN displays the default topic list in the Help browser.

See also help, doc, lookfor, what, which, dir, more.

Reference page in Help browser

doc helpwin

<lookfor> - Search all M-files for keyword.

LOOKFOR Search all M-files for keyword.

LOOKFOR XYZ looks for the string XYZ in the first comment line

(the H1 line) of the HELP text in all M-files found on MATLABPATH

(including private directories). For all files in which a

match occurs, LOOKFOR displays the H1 line.

For example, "lookfor inverse" finds at least a dozen matches,

including the H1 lines containing "inverse hyperbolic cosine"

"two-dimensional inverse FFT", and "pseudoinverse".

Contrast this with "which inverse" or "what inverse", which run

more quickly, but which probably fail to find anything because

MATLAB does not ordinarily have a function "inverse".

LOOKFOR XYZ -all searches the entire first comment block of

each M-file.

In summary, WHAT lists the functions in a given directory,

WHICH finds the directory containing a given function or file, and

LOOKFOR finds all functions in all directories that might have

something to do with a given key word.

See also dir, help, who, what, which.

Reference page in Help browser

doc lookfor

Accessing information about MathWorks products and technical support

<info> - Information about MATLAB and MathWorks.

INFO Information about MathWorks.

INFO displays information about MathWorks in the Command Window.

See also whatsnew.

Overloaded methods:

vdspdebug/info

haver/info

mfilt.info

adaptfilt.info

ghsmulti/info

xregpointer/info

mbcreference/info

cgrules/info

xregdesign/info

designdev/info

des_respsurf/info

xregmodel/info

dfilt.info

ccsrtdx/info

ccsdebug/info

Reference page in Help browser

doc info

<support> - Open MathWorks Technical Support Web Page.

SUPPORT Open MathWorks Technical Support Web Page.

SUPPORT, with no inputs, opens your web browser to The MathWorks

Technical Support Web Page at http://www.mathworks.com/support.

On this page, you will find links to

- a Solution Search Engine

- a "virtual Technical Support Engineer" that, through a

series of questions, determines possible solutions to the

problems you are experiencing

- Technical Notes

- Tutorials

- Bug fixes and patches

See also web.

Reference page in Help browser

doc support

<whatsnew> - Access Release Notes.

WHATSNEW Access Release Notes via the Help browser.

WHATSNEW displays the Release Notes in the Help browser, presenting

Соседние файлы в папке Библиотеки Matlab