Sequence File Documentation Dialog Box

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Select Tools»Sequence File Documentation to launch the Sequence File Documentation dialog box, in which you can generate an HTML or text document that contains all information about the sequences and steps in a selected sequence file.

The Sequence File Documentation dialog box contains the following options:

  • Generate Documentation For—The name and location of the sequence file.
  • File Format—The file format of the documentation file. The options are HTML and Text.
  • Destination File Path—The name and location of the documentation file to create.

The Properties/Variables section contains the following options:

  • Show Parameters—When you enable this option, sequence parameters are visible in the documentation file.
  • Show Sequence File Globals—When you enable this option, sequence file global variables are visible in the documentation file.
  • Show Locals—When you enable this option, sequence local variables are visible in the documentation file.
  • Show Station Globals—When you enable this option, the current station global variables are visible in the documentation file.

The Value Display Options subsection contains the following options:

  • Show Subproperties—Enable this control to make the subproperties of structured variables visible in the documentation file.
  • Show Array Elements—Enable this control to make the elements of array variables visible in the documentation file.
  • Maximum Number of Elements to Show—The maximum number of array elements from an array variable to include in the documentation file.
  • Show Hidden Properties—Enable this control to make variables or properties marked as hidden visible in the documentation file.

Enable the Launch Viewer When Done option to specify that the documentation tool opens the documentation file in a viewer application.

WAS THIS ARTICLE HELPFUL?

Not Helpful