Command line description

Name of the tool has changed from Antidoc in v1.x.y to antidoc in v2.x.y.

Call

Command call

g-cli --lv-ver <LabVIEW version number> antidoc -- (1)

1	paremeters specific to Antidoc tool follow "--"

Generic parameters

Table 1. Parameters
Name	Category	Required	Description
-addon	Value	Yes	Add-on selection. For LabVIEW project add-on use `lvproj` For LabVIEW toolkit add-on use `toolkit`
-out	Value	Yes	Path of the folder where the document are generated
-configpath	Value	No	Path of the configuration file. If not set, Antidoc will use the add-on default configuration to generate the document
-commit	Value	No	Commit revision of the documented code
-commitdate	Value	No	Commit date of the documented code
-tag	Value	No	Tag of the documented code
-render	Value	No	If not set, the tool only generates adoc files To render the final document, set to `html` or `pdf` NOTE: if the value is empty or contain a misspeling, the HTML version will be rendered

LabVIEW project parameters add-on

Table 2. Parameters
Name	Category	Required	Description
-pp	Value	Yes	Path of the lvproj file to parse
-t	Value	Yes	Generated document title
-a	Value	No	Author name Default value: Antidoc`
-e	Value	No	Author’s e-mail Default value: <empty>

LabVIEW toolkit parameters add-on

Table 3. Parameters
Name	Category	Required	Description
-mnu	Value	Yes	Path to the mnu file used as a starting point for generating the documentation
-toolkitname	Value	Yes	Name of the toolkit
-toolkitversion	Value	Yes	Version of the toolkit
-descpath	Value	No	Adoc file path used to add toolkit description

Examples

Command to generate the documentation of a LabVIEW project

g-cli --lv-ver 2021 antidoc -- -addon lvproj -pp "<lvproj path>" -t "Document Title" -out "<documentation generated folder path>" -a "Olivier Jourdan" -e "olivier.jourdan@wovalab.com" -configpath "<config file path>" -commit "se42as2" -commitdate "2020-09-30" -tag "v1.4.2"

Command to generate the documentation of a LabVIEW toolkit

g-cli --lv-ver 2021 antidoc -- -addon toolkit -mnu "C:\Program Files (x86)\National Instruments\LabVIEW 2021\vi.lib\addons\Wovalab\functions_Wovalab_lib_AntiDoc.mnu" -toolkitname "Antidoc" -toolkitversion "v2.0.2.117" -descpath "<adoc file path>"  -out "<documentation generated folder path>"