How to generate the documentation of your LabVIEW project?

  1. Start Antidoc user interface

  2. Select the LabVIEW toolkit document type if necessary

  3. Fill in the different fields

  4. Optionally, set-up the options

  5. Click on the Generate documentation button

  6. Render the document into your preferred file format

Main settings

Main setting for toolkit documentation
Figure 1. main settings user interface
1 Toolkit name
2 Toolkit version
3 main *.mnu file that describes the toolkit’s function palettes
4 Folder where the final document will be stored at the end of the process

Options

Click the `More options…`button to access the optional settings dialog.

Options window description

Main setting for toolkit documentation
Figure 2. optional settings dialog
1 The content of the adoc file set will be added in the first section of the document generated
2 Descriptions retrieved in the VI are striped as soon as one of the tokens listed here is found

Add a toolkit description

You can add custom description in the first section of the document using a text file using AsciiDoc syntax.

Toolkit description file content example
This toolkit provides a set of vis that helps you builds plain-text file using asciidoc syntax.

It now provides all the tools needed to generate the HTML5 or PDF final document you always dream to get from your LabVIEW applications.

*Author:* Olivier Jourdan

*Copyright:* Copyright (C) 2022, Wovalab

*License:* BSD 3-Clause

*Compatible LabVIEW Versions:* >= 2014.

*Compatible OS Versions:* Windows 64-Bit.
AsciiDoc

This file will be included in the final document to give the following result.

Toolkit description section
Figure 3. Result in the final document