Block Type: Documentation (MATLAB Report Generator)

Catagory

Description

This component inserts text extracted from doc blocks in Simulink models. The Block Type: Documentation component can have either the Model Loop, the System Loop, or the Block Loop component as its parent.

Attributes

This is the Block Type: Documentation attribute page.

Note To view a component attribute page in the Setup File Editor, select the component in the setup file outline on the left and click on the Options tab. If the component is not in the setup file outline, you must add it to the outline first. See Building and Editing the Setup File for a discussion on how to add a component to the outline.

Extract Text From

This frame describes what the Block Type: Documentation component is operating on:

If the Block Type: Documentation component has the Model Loop as its parent, it extracts the text from all of the doc blocks in the current model.
If the Block Type: Documentation component has the System Loop as its parent, it extracts the text from all of the doc blocks in the current system.
If the Block Type: Documentation component has the Block Loop as its parent, it extracts the text from the current block if it is a doc block.
The Block Type: Documentation component will not work with the Signal Loop as its parent.
If the Block Type: Documentation component does not have any of the Simulink looping components as its parent, it extracts the text from all of the doc blocks in all open models.

Text Format

Insert linking anchor for blocks: Select this option to insert a linking anchor for each doc block . This designates the location to which other links for that block will point. (See the Object Linking Anchor or Link components for more help.) You should not use this option if you have already specified an anchor location for the doc block with an Object Linking Anchor component.


Import text as:

Plain text (ignore line breaks): Select this option to import plain text without any line breaks (no paragraphs).

In this example and subsequent examples, the following text is used as the input text
- ```
This is the first row of imported text from the doc block.
  The second row follows a line break in the first row.

There is a blank line above the third row.
```
With the Plain text (ignore line breaks) option, the following is produced.

This is the first row of imported text from the doc block. The second row
follows a line break in the first row. There is a blank line above the
third row.

Paragraphs defined by line breaks: Select this option to import the text contained in paragraphs defined by line breaks (hard returns or carriage returns).

With the Paragraphs defined by line breaks option, the following is produced.

This is the first row of imported text from the doc block.
The second row follows a line break in the first row.
There is a blank line above the third row.

Paragraphs defined by empty rows: Select this option to import text contained in paragraphs defined by empty rows (rows that do not contain text).

With the Paragraphs defined by empty rows option, the following is produced.

This is the first row of imported text from the doc block. The second row
follows a line break in the first row.
There is a blank line above the third row.

Text (retain line breaks): Select this option to import plain text, including line breaks .

With the Text (retain line breaks) option, the following is produced.

This is the first row of imported text from the doc block.
The second row follows a line break in the first row.
There is a blank line above the third row.

Fixed-width text (retain line breaks): Select this option to import fixed-width text (all letters have the same width or size) including line breaks. This option is best suited for importing M-files.

With the Fixed-width text (retain line breaks) option, the following is produced.

This is the first row of imported text from the doc block. The second row follows a line break in the first row. There is a blank line above the third row.

Insert anything into report?

Yes. Text or paragraph.

Filename

csl_blk_doc

Block Type Count Block Type: Look-Up Table