MATLAB Function - Insert information about MATLAB Function block contents

Description

This component displays tables with information about MATLAB code included in MATLAB Function blocks. You specify which of the following kinds of information to include in the report:

• Function properties — Parameter settings for the MATLAB Function block

• Argument properties — Properties of the function arguments (for example, complexity)

• The function script — MATLAB code of the function

• Supporting functions — User-defined functions and, optionally, MATLAB functions that are included in the MATLAB Function block function.

For details about MATLAB Function blocks, see the MATLAB Function block reference page.

Use the MATLAB Function component within a section, paragraph, or table.

Note   To view the contents of a MATLAB Function block in a Web viewer, use the Web view feature of the Simulink Report Generator. In the Web view, hover your cursor over the MATLAB Function block. For details, see Export Simulink Models to Web Views.

Function Properties Table

• Include function properties: Generates a table with function property information.

• Table title: Insert a title for the function properties table.

  • Automatic: Use the default title for the table.

  • Custom: Use the title that you specify for the table.

• You can change the header text for property and value columns of the function properties table. In the Header column, double-click to change the header text. The Width column indicates the relative width, in relative terms, based on the smallest width you specify. For example, for a three-column table, if the first column width is 1, and the column width of the other two columns is 3, then the second and third columns is three times wider than the first column.

• Grid lines: Show grid lines for the table.

• Spans page width: Make the table as wide as the page.

Argument Summary Table

• Include argument summary table: Generate a table with summary information about the MATLAB Function block function arguments.

• Table title: Insert a title for the argument summary table.

  • Automatic: Use the default title for the table.

  • Custom: Use the title that you specify for the table.

• Argument Summary Table Options: Specify the property columns to include in the table.

  • To add a property column:

    1. In the table on the right, select a property near where you want to insert the new property column.

    2. From the list of properties to the left of the table, select a property that you want to add to the table.

    3. Click the left-arrow button.

    4. If necessary, use the up or down arrow button to position the new column.

  • To delete a property column, select the property in the table and click the right-arrow button

  • You can change the header text for property and value columns of the table. In the Header column, double-click to change the header text. The Width column indicates the relative width, in relative terms, based on the smallest width you specify. For example, for a three-column table, if the first column width is 1, and the column width of the other two columns is 3, then the second and third columns is three times wider than the first column.

• Grid lines: Show grid lines for the table.

• Spans page width: Make the table as wide as the page.

• Column alignment: Align the text in each column:

  • Left

  • Center

  • Right

  • Double justified

Detailed Argument Report

• Include detailed argument report: Generate a table with detailed information about the MATLAB Function block function arguments.

• Argument Property Table Format Options: Specify the argument property columns to include in the table.

  • Table title: Insert a title for the argument properties table.

    • Automatic: Use the default title for the table.

    • Custom: Use the title that you specify for the table.

  • You can change the header text for property and value columns of the table. In the Header column, double-click to change the header text.

  • Grid lines: Show grid lines for the table.

  • Spans page width: Make the variable table as wide as the page on which the table appears.

• Include function script: Include the script for the function.

• Highlight script syntax: Use colors to highlight syntax keywords.

• Include supporting functions: Include a list of functions invoked directly or indirectly by the function script. If you specify to include supporting functions in the report, also specify whether to include both MATLAB and user-defined functions or just user-defined functions.

• Supporting Function Table Format Options:

  • Table title: Insert a title for the supporting functions table.

    • Automatic: Use the default title for the table.

    • Custom: Use the title that you specify for the table.

  • You can change the header text for property and value columns of the table. In the Header column, double-click to change the header text. The Width column indicates the relative width, in relative terms, based on the smallest width you specify. For example, for a three-column table, if the first column width is 1, and the column width of the other two columns is 3, then the second and third columns is three times wider than the first column.

  • Grid lines: Show grid lines for the table.

  • Spans page width: Make the table as wide as the page.

Insert Anything into Report?

Yes. Tables and, optionally, code.

Class

rptgen_sl.csl_emlfcn

See Also

Stateflow Property

© 1984-2012- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS