rtwreport - Document generated code

Syntax

rtwreport(model, dir)

dir is optional.

Arguments

model

The model for which generated code is to be documented.

dir (optional)

The directory that contains the generated code. Specify this argument only if the build directory is not in the current directory or in the directory that stores the model. The directory you specify must be a standard build directory and its parent directory must include the model's project directory (slprj) .

Description

The rtwreport function generates a report that documents the generated code for a specified model. If necessary, the function loads the model and generates code before generating the report, which includes:

By default, the Real-Time Workshop® software names the generated report codegen.html and places the file in the current directory. If you specify an optional directory, the Real-Time Workshop software places the file codegen.html in the parent directory of the specified directory. If the specified directory is not found, an error results and the Real-Time Workshop software does not attempt to generate code for the model.

Example

Generate a report for mymodel.

rtwreport(mymodel);

See Also

Documenting a Code Generation Project

  


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