Generate Documentation Method

FlexRIO Help

Edition Date: November 2015

Part Number: 372614J-01

»View Product Info

»Download the Help in ZIP Format

Short Name: Generate Documentation

Requires: Base Development System

Class: StatechartLibrary Methods

To Use: Create a method.

Generates an XML file that contains information about all components, including states, pseudostates, connectors, regions, and transitions, of a statechart. You can view the XML file in a Web browser.

This method also generates a folder of support files in the same location as the XML file you generate. This support folder contains files that the XML file references, including images of the statechart components, an EXtensible Stylesheet Language Transformations (XSLT) file, and an XML Schema Definition (XSD) file.

Note  You may freely distribute your generated XML file and support folder containing the XSLT and XSD files. However, National Instruments claims all copyrights on NI_Statechart_Documentation_Tool.xslt and NI_Statechart_Documentation_Tool.xsd. Do not use or distribute these files except with the associated XML file and support folder generated by the LabVIEW Statechart Module Generate Documentation feature. You may modify NI_Statechart_Documentation_Tool.xslt, but the file must retain the National Instruments copyright notice contained therein, which may not be modified or obscured. You also must add a prominent notice at the top of the file that states that you have modified the file. You may not modify NI_Statechart_Documentation_Tool.xsd.

This method is similar to the Generate Documentation item on the shortcut menu of an .lvsc item, or statechart library, in a statechart project. This method also is similar to the File»Generate Documentation menu item in the Statechart Editor window.


Data typeNameRequiredDescription
PathYesSpecifies the location to which LabVIEW saves the XML file and the folder of support files. The path you specify must end in the .xml file extension. The default value is the same location as the statechart you document.


The following table lists the characteristics of this method.

Data typeNo return value
Available in Run-Time EngineNo
Available in Real-Time Operating SystemNo
Settable when the VI is runningNo
Loads the front panel into memoryNo
Need to authenticate before useNo
Loads the block diagram into memoryNo
Remote access allowedYes


Not Helpful