Generate Documentation
- Updated2025-03-14
- 2 minute(s) read
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.
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.
Parameters
Name | Data type | Required | Description |
---|---|---|---|
Path | ![]() |
Yes | Specifies 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. |
Remarks
The following table lists the characteristics of this method.
Short Name | Generate Documentation |
Data type | No return value |
Available in Run-Time Engine | No |
Available in Real-Time Operating System | No |
Settable when the VI is running | No |
Loads the front panel into memory | No |
Need to authenticate before use | No |
Loads the block diagram into memory | No |
Remote access allowed | Yes |