How to generate the documentation of your LabVIEW project?
-
Start Antidoc user interface through the LabVIEW
-
Select the
LabVIEW projectdocument type -
Fill in the different fields
-
Optionally, set up the options
-
Click on the
Generate documentationbutton
Main settings
Figure 1. main settings user interface
| 1 | Path of the project you want to document |
| 2 | Title of the document |
| 3 | Name of the author |
| 4 | E-mail of the author |
Options
Click the More options… button to access the optional settings dialog.
Figure 2. optional settings dialog
| 1 | If enabled, parsing of the project includes the project dependencies |
| 2 | If enabled, the DQMH modules sections list the default requests a DQMH module already has when created |
| 3 | If enabled, the private VIs of lvlib and lvclass are listed in the document |
| 4 | All lvlib and lvclass containing one of the tokens listed here are not parsed |
| 5 | Descriptions retrieved in the code are striped as soon as one of the tokens listed here is found |