Creating and Editing VI Descriptions

LabVIEW 2018 Help


Edition Date: March 2018
Part Number: 371361R-01
View Product Info

DOWNLOAD (Windows Only)


LabVIEW 2016 Help
LabVIEW 2017 Help
LabVIEW 2018 Help
LabVIEW 2019 Help
LabVIEW 2020 Help

Create descriptions for VIs to describe the purpose of the VI and to give users instructions for using the VI. The VI description appears in the Context Help window when you move the cursor over the VI icon and in VI documentation you generate.

Complete the following steps to create and edit the description of a VI.

  1. Select File»VI Properties to display the VI Properties dialog box.
  2. Select Documentation from the Category pull-down menu.
  3. Enter or edit a description of the VI in the VI description text box. You can format the text in the description to appear bold in the Context Help window.
  4. (Optional) Link from the VI to an HTML file or compiled help file.
  5. Click the OK button to save the changes.
Note  You cannot edit subVI descriptions from the calling VI block diagram. To edit a subVI description, open the subVI, select File»VI Properties in the subVI, and select Documentation from the Category pull-down menu.

You also can use the VI Description property to create and edit the VI description programmatically.

WAS THIS ARTICLE HELPFUL?

Not Helpful