VALADOC(1) User Commands VALADOC(1)

# [NAME](#NAME)

valadoc - Vala Documentation Tool

# [SYNOPSIS](#SYNOPSIS)

**valadoc** \[*OPTION*]... *FILE*...

# [DESCRIPTION](#DESCRIPTION)

Valadoc is a documentation generator for generating API documentation from Vala source code based on libvala.

## [Usage:](#Usage:)

valadoc \[OPTION???] FILE... - Vala Documentation Tool

## [Help Options:](#Help_Options:)

[**-h**, **--help**](#h)

Show help options

## [Application Options:](#Application_Options:)

[**-o**, **--directory**=*DIRECTORY*](#o)

Output directory

[**-b**, **--basedir**=*DIRECTORY*](#b)

Base source directory

[**-D**, **--define**=*SYMBOL*...](#D)

Define SYMBOL

[**--profile**=*PROFILE*](#profile)

Minimum runtime dependency: 'gobject' (default) or 'posix' (minimal libc)

[**--enable-experimental**](#enable)

Enable experimental features

[**--enable-experimental-non-null**](#enable~2)

Enable experimental enhancements for non-null types

[**--metadatadir**=*DIRECTORY*...](#metadatadir)

Look for GIR .metadata files in DIRECTORY

[**--girdir**=*DIRECTORY*...](#girdir)

Look for .gir files in DIRECTORY

[**--vapidir**=*DIRECTORY*...](#vapidir)

Look for package bindings in DIRECTORY

[**--pkg**=*PACKAGE*...](#pkg)

Include binding for PACKAGE

[**--driver**](#driver)

Name of an driver or path to a custom driver (DEPRECATED AND IGNORED)

[**--importdir**=*DIRECTORY*...](#importdir)

Look for external documentation in DIRECTORY

[**--import**=*PACKAGE*...](#import)

Include binding for PACKAGE

[**--alternative-resource-dir**=*DIRECTORY*...](#alternative)

Alternative resource directories

[**--wiki**=*DIRECTORY*](#wiki)

Wiki directory

[**--deps**](#deps)

Adds packages to the documentation

[**--doclet**=*PLUGIN*](#doclet)

Name of an included doclet or path to custom doclet

[**-X**, **--doclet-arg**=*ARG*](#X)

Pass arguments to the doclet

[**--no-protected**](#no)

Removes protected elements from documentation

[**--internal**](#internal)

Adds internal elements to documentation

[**--private**](#private)

Adds private elements to documentation

[**--use-svg-images**](#use)

Generate SVG image charts instead of PNG

[**--package-name**=*NAME*](#package)

package name

[**--package-version**=*VERSION*](#package~2)

package version

[**--gir**=*NAME-VERSION*.gir](#gir)

GObject-Introspection repository file name

[**--version**](#version)

Display version number

[**--force**](#force)

force

[**--fatal-warnings**](#fatal)

Treat warnings as fatal

[**--verbose**](#verbose)

Show all warnings

[**--no-color**](#no~2)

Disable colored output

[**--target-glib=**'MAJOR.MINOR', or 'auto'](#target)

Target version of glib for code generation

# [BUGS](#BUGS)

https://gitlab.gnome.org/GNOME/vala/issues

# [HOMEPAGE OR CONTACT](#HOMEPAGE_OR_CONTACT)

https://docs.vala.dev

# [AUTHORS](#AUTHORS)

Florian Brosch

March 2026 Valadoc 0.56.19

---

Document: valadoc-0.56(1) from vala 0.56.19-r2 (Chainguard OS)
Source: https://gitlab.gnome.org/GNOME/vala