Command line description

Call

Command call
g-cli --lv-ver <LabVIEW version number> Antidoc -- (1)
1 paremeters Specific to Antidoc tool follow "--"

Parameters

Table 1. Parameters
Name Category Required Description

-pp

Value

Yes

Path of the lvproj file to parse

-t

Value

Yes

Generated document title

-out

Value

Yes

Path of the file generated by Antidoc

-a

Value

No

Author name
Default value: "Antidoc"

-e

Value

No

Author’s e-mail
Default value: <empty>

-notfull

Flag

No

If set, document generated only contains sections. This could be helpfull when you use Antidoc API in your own tool

-configpath

Value

No

Path of the configuration file.
If not set, Antidoc will use the 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

-nousagereport

Flag

No

If set, usage reporting is deactivated. See usage reporting in Antidoc for more information
Table 2. Deprecated Parameters
Name Category Description Last version availability

-dep

Flag

If set, Antidoc parse libraries contained in project Dependencies

1.0.0.2 (replace by config file)

Examples

Command with only required parameters
g-cli --lv-ver 2014 Antidoc -- -pp  "<lvproj path>" -t "Document Title" -out "<output file path>"
Command with all parameters set
g-cli --lv-ver 2014 Antidoc -- -pp "<lvproj path>" -t "Document Title" -out "<output file path>" -a "Jean Dupont" -e "jean-dupont@abcde.com" -notfull -configpath "<config file path>" -commit "se42as2" -commitdate "2020-09-30" -tag "v1.2.3" -nousagereport
Command with required parameters and flags
g-cli --lv-ver 2014 Antidoc -- -pp  "<lvproj path>" -t "Document Title" -out "<output file path>"