The LabVIEW tool

You can use Antidoc directly from the LabVIEW interface.

To open the tool, select Tools  Antidoc  Generate Documentation…

Selecting an add-on

Add-ons give you the possibility to generate different kinds of documents.

If more than one add-on is installed, a dialog appears to let you choose the type of document you want to generate.

Antido add-on selection
If only one add-on is installed, the main UI is open directly.

User interface

After selecting your add-on, the main user interface is loaded. The interface is divided into two different parts.

Antidoc main user interface
1 Add-on specific user interface
2 Generic user interface

To generate the document, click on the button Generate documentation.

At the end of the generation, you can choose to:

  • Generate your document in HTML or PDF format.

  • Open the source file of the document written in AsciiDoc syntax.

  • Exit Antidoc.

Antidoc end of generation dialog
The final dialog box will remain open until you close it with the 'Quit' button or with the cross button at the top right of the window. So, you can use the three other buttons before exiting the tool.

Advanced configuration

You can configure advanced Antidoc behavior using an INI file named Antidoc.ini stored in ..\Documents\LabVIEW Data\Antidoc.

This file is not mandatory to get Antidoc to work. By default, this file doesn’t exist.
Antidoc.ini file content
[Antidoc]
AdditionalAddonsSearchPath="C:\Users\team\Documents\open-source-projects"(1)
AdditionalAddonsSearchPathLvVersion=14.0.1f11(2)
ContentNotFoundPlaceholder="Another placeholder text"(3)

[Custom Attributes](4)
toclevels=4
sectnuùmslevels=4
stylesheet=MyCustomStylesheet.css
1 Additional path where Antidoc is looking for add-ons. Use this parameter if you develop your add-on and want to debug it without building a package.
2 Limit the search for additional add-ons to a specific LabVIEW version.
3 Set a custom string to display in the documentation generated when content is not found in the LabVIEW code
4 In this section, each key represents an AsciiDoc attribute. That’s the way for you to customize the output (the PDF or the HTML) you can get at the end of the documentation generation process
For more information about AsciiDoctor attributes see the Asciidoctor documention