Generating Documentation
- Updated2023-02-21
- 1 minute(s) read
Options»Generate Documentation
The Generate Documentation submenu contains menu items that you can use to create various types of documentation for the function tree. This option uses the help text from the function panels in the function tree as the source for the generated documentation. You can create HTML files or a plain text file. LabWindows/CVI generates the documentation in the same folder as the function tree.
- HTML—Creates one HTML file per function panel in the function tree, one HTML file per class, an alphabetical function list, and a hierarchical function list. LabWindows/CVI creates these files in a folder named InstrumentDriverFilename_files. LabWindows/CVI also creates an overview file (InstrumentDriverFilename.html) and an HTML Help project file (InstrumentDriverFilename.hhp), which are placed in the same directory as the InstrumentDriverFilename_files folder.
You can use an HTML help compiler application to create a Microsoft Compiled Help file (.chm) with the generated .hhp file. - Plain Text—Creates a text file (.doc) that contains a function tree overview, class overviews, and function reference.
For both options, you can include instrument driver information, which describes error information and conditions for using your functions with different types of instrument drivers. You also can select whether to include function prototypes for C or Microsoft Visual Basic in the generated documentation.