Programmatically Generating HTML Documentation for VIs

Updated Jun 30, 2024

Environment

Software

  • LabVIEW

It is possible to Generate HTML Documentation for VIs via an integrated function in the File section of the top bar of LabVIEW. In this article, there will be discussed the steps of generating the HTML documentation programmatically.

As described in the Generating HTML Documentation for VIs, Templates, and Objects manual, there is an integrated function, which you can use for generating a VI documentation.

Report Generation Toolkit
If you do need to generate a VI documentation programmatically, you can use a LabVIEW Report Generation Toolkit.
Refer to the example located in the C:\Program Files\National Instruments\LabVIEW 2024\examples\Report Generation folder.

Invoke Node
In another way, you can generate VI documentation by calling the integrated function through the Invoke Node.
Place an Invoke Node from the Application Control palette, place an Open VI Reference function, and connect Open VI Reference to the Invoke Node. Left-click on the Invoke Node and select Print>>VI to HTML.
The VI should look the same as in the screenshot below.

VI Documentation.png