Using Simulink    

The Documentation Pane

The Documentation pane enables you to define or modify the type, description, and help text for a masked block. This figure shows how fields on the Documentation pane correspond to the mx + b sample mask block's dialog box.

Mask Type Field

The mask type is a block classification used only for purposes of documentation. It appears in the block's dialog box and on all Mask Editor panes for the block. You can choose any name you want for the mask type. When Simulink creates the block's dialog box, it adds "(mask)" after the mask type to differentiate masked blocks from built-in blocks.

Mask Description Field

The block description is informative text that appears in the block's dialog box in the frame under the mask type. If you are designing a system for others to use, this is a good place to describe the block's purpose or function.

Simulink automatically wraps long lines of text. You can force line breaks by using the Enter or Return key.

Block Help Field

You can provide help text that is displayed when the Help button is clicked on the masked block's dialog box. If you create models for others to use, this is a good place to explain how the block works and how to enter its parameters.

You can include user-written documentation for a masked block's help. You can specify any of the following for the masked block help text:

Simulink examines the first line of the masked block help text. If it detects a URL specification, web command, or eval command, it accesses the block help as directed; otherwise, the full contents of the masked block help text are displayed in the browser.

These examples illustrate several acceptable commands:

Simulink automatically wraps long lines of text.


  The Initialization Pane Linking Mask Parameters to Block Parameters