National Instruments 370769C-01 Generating Documentation from the OS, Generate a Textual Version of a Model

Chapter 2 Invoking DocumentIt
© National Instruments Corporation 2-7 DocumentIt User Guide
Generating Documentation from the OS
If a model file already exists, it is also possible to execute DocumentIt from
the operating system prompt. The input file for processing must be a
real-time file (.rtf). At the operating system prompt, execute the
command:
% autostar {options} model_file .rtf
Many of the options are the same as the fields in the documentation
generation dialog. Refer to AppendixA, DocumentIt Options, for a
complete list of DocumentIt options.
DocumentIt runs, creating a document file. When the operating system
prompt returns, the process is complete.
Examples:
% autostar -h
shows a help display.
% autostar -doc -t FM.tpl SysBld_file .rtf
processes the model file SysBld_file .rtf using a template file named
FM.tpl to produce a document file named SysBld_file .doc. It assumes
the template file FM.tpl exists in your working directory.
Note The DocumentIt real-time file (.rtf) input file is not the same as the rich text
format file (.rtf) word processing output file. Only the file extension is the same.
Generate a Textual Version of a Model
One use of DocumentIt is to generate a textual version of a model. For
example, the TPL sample file (block_info.tpl) shown in Example2-1
generates output similar to the text shown in Example2-2, which
documents the Arbitrate Throttle Control SuperBlock from the Supercruise
demo model.
Example 2-1 Sample TPL File for Documenting a Block
@SEGMENT MAIN() INT i, j@@
@LOOPP i eq 0, i lt nsupblks_i, i=i plus 1@@
@SCOPE SUPERBLOCK i@@
superblock name: @sb_name_s@
superblock inputs: @num_sb_in_i@
superblock outputs: @num_sb_out_i@