StatechartLibrary class/Generate Documentation method

VI Server Method Information
Method ID	18A16403
Scope	Basic Development Environment
Data Name	Generate Documentation
Short Name*	Generate Documentation
Long Name*	Generate Documentation
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID	126
Owning Class Name	StatechartLibrary Class
Return Data Type	No return value
Invoke Node
Available in Real-Time Operating System	No
Available in Run-Time Engine	No
Loads the block diagram into memory	No
Loads the front panel into memory	No
Need to authenticate before use	No
Remote access allowed	Yes
Settable when the VI is running	No

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.

Parameters

Data type	Name	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.

History

Version	Change(s)
	This method was added in LabVIEW 2009.