What is documented

The add-on parses the lvproj content to find information and build the documentation.

The document hierarchy follows the order of the sections below.

If the content is not found. The corresponding section doesn’t appear in the documentation generated.
For example, if there are no classes in the project, you’ll not have a Classes section.

Project description

This section describes your project

Figure 1. Project section sample

Source of information

Content comes from the lvproj description.

DQMH® modules

This section describes DQMH® modules and their relationship contained in your project.

The section starts with a table listing all modules in the project and an overall relationship diagram.

DQMH modules overview in the documentation

Figure 2. DQMH® modules overview section sample

Then a specific section is created for each module with the following content:

Module type, Singleton or Cloneable.
Responsibility, description of the lvlib file.
Module relationship:
- Diagram between this module and the rest of the project
- Table listing the Requests callers
- Table listing the Broadcasts listeners
- Table listing other modules Requests used by this module
- Table listing other modules Broadcasts listened to by this module
Event list, all Requests, Requests and Wait For Reply, and Broadcasts available in the module
Module’s Start and Stop requests callers
Module Helper Loops, a list of the helper loops found in the module
Module custom errors, a list of the custom errors created in the module
Module Constant VIs, a list of the constant VIs created in the module

DQMH module section in the documentation

Figure 3. DQMH® module section sample

Source of information

Content comes from:

Module library description.
Requests, Requests and Wait For Reply, and Broadcasts VIs descriptions.
Relationship information is obtained by code analysis.
Error VIs → vi named *--error.vi
Constant VIs → vi named *--constant.vi

Librairies

For each library, a specific section is created with the following content:

Responsibility, description of the lvlib file.
Version, version of the lvlib file.
Functions, table of all non-private functions with their name, connector pane picture, description, scope setting, reentrancy setting, and inlining setting.

Figure 4. Library section sample

Source of information

Content comes from:

The lvlib description.

The lvlib version.

List of VIs owned by the library.

Classes

A table lists all classes and interfaces in the project and a UML class diagram is displayed.

Figure 5. Classes overview section sample

For each class, a specific section is created with the following content:

Responsibility, description of the lvlib file.
Version, version of the lvlib file.
UML Class diagram, direct parent class diagram
Functions, table of all non-private functions with their name, connector pane picture, description, scope setting, reentrancy setting, and inlining setting.

Figure 6. Class section sample

Source of information

Content comes from:

The lvclass description.
The lvclass version.
List of VIs owned by the class.
Class hierarchy diagrams are obtained by code analysis.

JKI State Machines

This section lists all the VIs that contain a JKI State Machine.

JKI State Machine description in the documentation

Figure 7. JKI State Machine section sample

Source of information

Content comes from:

Owning VI description and connector pane
Code diagram
Comment in cases

Custom errors

Custom errors find by the Antidoc add-on: LabVIEW project are the ones that follow the DQMH® framework way to create custom errors

A table lists all the custom errors find in the project with the following information:

Custom error section in the documentation

Figure 8. Custom errors section sample

Name, name of the error
Code, code of the error
Description, description of the error
Owned by, LabVIEW library that owns the error

Source of information

Content comes from:

Analysis of VIs that have a name that finishes by --error.vi