Learn more about Simulink

DocBlock - Create text that documents model and save text with model

Library

Model-Wide Utilities

Description

The DocBlock allows you to create and edit text that documents a model, and save that text with the model. Double-clicking an instance of the block creates a temporary file containing the text associated with this block and opens the file in an editor. Use the editor to modify the text and save the file. Simulink software stores the contents of the saved file in the model file.

The DocBlock supports HTML, Rich Text Format (RTF), and ASCII text document types. The default editors for these different document types are

HTML — Microsoft^® Word (if available). Otherwise, the DocBlock opens HTML documents using the editor specified on the Editor/Debugger Preferences pane of the Preferences dialog box.
RTF — Microsoft Word (if available). Otherwise, the DocBlock opens RTF documents using the editor specified on the Editor/Debugger Preferences pane of the Preferences dialog box.
Text — The DocBlock opens text documents using the editor specified on the Editor/Debugger Preferences pane of the Preferences dialog box.

Use the docblock command to change the default editors.

Note Simulink software embeds DocBlock documents in the model file (see Model File Format). This can greatly increase the size of a model file, for example, if the RTF document contains bitmapped images, and can require more time to open and save the model.

Data Type Support

Not applicable.

Parameters and Dialog Box

Double-clicking an instance of the DocBlock opens an editor. To access the DocBlock parameter dialog box, select the block in the Model Editor and then select Mask Parameters from either the Edit menu or the block's context menu.

RTW Embedded Coder Flag (Real-Time Workshop^® Embedded Coder™ license required)

Enter a template symbol name in this field. Real-Time Workshop Embedded Coder software uses this symbol to add comments to the code generated from the model. See in the documentation for more information.

Document Type

Specifies the type of document associated with the DocBlock. The options are