valadoc1
Vala documentation tool
Usage
valadoc [OPTION] ...
FILE ...
Overview
Valadoc is a documentation generator for generating API documentation from Vala source code based on libvala.
Usage:
-
valadoc [OPTION???] FILE... - Vala Documentation Tool
Help Options:
-
-h, --help -
Show help options
Application Options:
-
-o, --directory=DIRECTORY -
Output directory
-
-b, --basedir=DIRECTORY -
Base source directory
-
-D, --define=SYMBOL... -
Define SYMBOL
-
--profile=PROFILE -
Minimum runtime dependency: 'gobject' (default) or 'posix' (minimal libc)
-
--enable-experimental -
Enable experimental features
-
--enable-experimental-non-null -
Enable experimental enhancements for non-null types
-
--metadatadir=DIRECTORY... -
Look for GIR .metadata files in DIRECTORY
-
--girdir=DIRECTORY... -
Look for .gir files in DIRECTORY
-
--vapidir=DIRECTORY... -
Look for package bindings in DIRECTORY
-
--pkg=PACKAGE... -
Include binding for PACKAGE
-
--driver -
Name of an driver or path to a custom driver (DEPRECATED AND IGNORED)
-
--importdir=DIRECTORY... -
Look for external documentation in DIRECTORY
-
--import=PACKAGE... -
Include binding for PACKAGE
-
--alternative-resource-dir=DIRECTORY... -
Alternative resource directories
-
--wiki=DIRECTORY -
Wiki directory
-
--deps -
Adds packages to the documentation
-
--doclet=PLUGIN -
Name of an included doclet or path to custom doclet
-
-X, --doclet-arg=ARG -
Pass arguments to the doclet
-
--no-protected -
Removes protected elements from documentation
-
--internal -
Adds internal elements to documentation
-
--private -
Adds private elements to documentation
-
--use-svg-images -
Generate SVG image charts instead of PNG
-
--package-name=NAME -
package name
-
--package-version=VERSION -
package version
-
--gir=NAME-VERSION.gir -
GObject-Introspection repository file name
-
--version -
Display version number
-
--force -
force
-
--fatal-warnings -
Treat warnings as fatal
-
--verbose -
Show all warnings
-
--no-color -
Disable colored output
--target-glib='MAJOR.MINOR', or 'auto'-
Target version of glib for code generation
Homepage or contact
https://docs.vala.dev
Releases
8 releases since Debian 7 (Wheezy); the text changed 6 times.
--alternative-resource-dir since Debian 10 (Buster);
--driver since Debian 9 (Stretch);
--fatal-warnings since Debian 11 (Bullseye);
--gir since Debian 9 (Stretch);
--girdir since Debian 9 (Stretch);
--import since Debian 9 (Stretch);
--importdir since Debian 9 (Stretch);
--metadatadir since Debian 9 (Stretch);
--no-color since Debian 10 (Buster);
--use-svg-images since Debian 10 (Buster);
--version since Debian 9 (Stretch);
-h since Debian 10 (Buster).
--disable-dbus-transformation until Debian 8 (Jessie);
--docudir until Debian 8 (Jessie);
--enable-checking until Debian 8 (Jessie);
--enable-deprecated until Debian 8 (Jessie);
--target-glib until Debian 10 (Buster).