Documentation

Insert text extracted from DocBlock blocks in Simulink models

Description

This component inserts text extracted from DocBlock blocks in Simulink® models. It can have the following components as its parent:

  • Model Loop

  • System Loop

  • Block Loop

The specified report format determines the format of the DocBlock block data inserted into the report:

  • HTML: Imports HTML data into the report.

    Note

    For non-English HTML DocBlock text that you want to include in a Documentation component, use UTF-8 file encoding. Use a simple text editor to create the HTML code.

  • RTF: Imports RTF data into the report.

Properties

  • Import file as: Specifies how to format the imported information. The following example shows how each option works, using the following text as input:

    First row.
  Second row.

Third row follows blank line.

    • Plain text (ignore line breaks). Imports plain text without any line breaks (no paragraphs), as in this example: 

      First row. Second row. Third row follows blank line.

    • Paragraphs defined by line breaks. Imports the text contained in paragraphs defined by line breaks (hard returns or carriage returns), as in this example: 

      First row.
Second row.

Third row follows blank line.

    • Paragraphs defined by empty rows. Imports text contained in paragraphs defined by empty rows (rows that do not contain text), as in this example: 

      First row. Second row.

Third row follows blank line.

    • Text (retain line breaks). Imports plain text, including line breaks, as in this example:

      First row.
Second row.

Third row follows blank line.

    • Fixed-width text (retain line breaks). Imports fixed-width text (all letters have the same width or size) including line breaks, as in this example:

      First row.
  Second row.

Third row follows blank line.

      Tip

      This option is useful for importing MATLAB® files.

  • Insert linking anchor for blocks: Inserts a linking anchor for each DocBlock block that designates the location where other links for that block point. (See the Simulink Linking Anchor or Link component reference pages for more help.) Do not use this option if you have already specified an anchor location for a DocBlock block with an Object Linking Anchor component.

Insert Anything into Report?

Yes. Text, paragraph, or external RTF/HTML data.

Class

rptgen_sl.csl_blk_doc

Simulink Report Generator Documentation

Support