LabVIEW API overview

You can integrate Antidoc features into your own LabVIEW code using the API provided during installation.

API description

Main palette

Table 1. Functions description

Name

Connector pane

Description

Create Doc

Create and set up the document.

Add Sections

Add sections to the document.

Generate Output

Generate the document using AsciiDoc syntax.

Add Code Revision Information

Add revision info to the document.

Create Section

Creat a section.

Add Blocs

Add bloc to a section.

Select the document you want to generate..

AntiDoc.lvlib Document Type.lvclass Select Document Type.vi

Oen the add-on selection dialog.

Launch Config Panel

Initialize and insert the configuration panel used to configure the docuementation generation.

Load Config

Load configuration contained in the file given in input.

Save Config

Save the current config in the path file given in input.

Load Default

Load the default configuration of the specific document type used.

Default configuration can overidden using the function Save default configuration. If default configuration file is not found, the Document Type default configuration will be used.

Save Default

Save the current configuration to the default file.

Update Config

Use this function to update the configuration modified by the user through the config panel.

Is Configuration Valid

Check if the current config is valid.

Initialize

Initialize the documentation generation process.

Parse

Get documentation content.

Compose

This function organizes the content in sections and ouput the sections representing the final document generated.

Get Final Document Info

Get general document information.

Release

Release any resources used during the documentation generation process.

Default Values

Get the default values of the document type configuration.

Obtain User Event

Obtain User Event reference to register to in order to get docuementation generation events.

Set Total Steps

Set the number of step expected during document generation.

this parameter is used to define the 100% info.

Initial Step

Initialize the first documentation generation step.

New step

Generate a new documentation step.

Release User Event

Release the User Event created in order to broadcast steps of the documentation generation.

Utilities

Table 2. Functions description
Name	Connector pane	Description
Check File Name Validity		Use this funtion to get a file name compatible with ascidoc syntax.
Copy File To Include		Use this function to copy a file you want to include in your document. The file name will be unique and compatible with the asciidoc syntax.
Is Malleable VI instance		Use this function to know if a VI name is one of an malleable instance VI.
Tool Info—constant		Use this function to know the name (Antidoc) and the version of the tool.