2. Command Line Tool

Warning

The valadoc command line tool may not be bundled with your installation of the Vala. You will need to find a way to install it on your operating system.

Usage:

valadoc [OPTION...] FILE...

2.1. Essential Options

-o,–directory=DIRECTORY

Output directory of the generated documentation.

The name of the directory will also be used as the package name if a package name has not been explicitly set and cannot be derived from any other sources

–package-name=NAME

Sets the name of the package of the generated documentation.

–package-version=VERSION

Sets the package version of the generated documentation.

–force

Force the documentation to be generated, even if the output directory already exists.

As stated in the quick start guide, with this option set, generated documentation is only added or overwritten.

–pkg=PACKAGE…

Specify bindings to include in the documentation via their package names.

–version

Display the version number of the valadoc tool.

-h, –help

View the list of all of the commands and options that valadoc supports.

You’ll see additional options that aren’t listed on this page when you use this option.