VALADOC(1)

📦
version 0.56.19 · 5 versions
, in alpine 3.24, arch rolling, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, ubuntu stonking

💖 VALADOC — the Vala Documentation Tool 💖

okay bestie, gather round, because valadoc is literally the moment. it's a User Command from the Vala crew and it's here to turn your source code into gorgeous API docs. no cap.

✨ NAME ✨

valadoc — the Vala Documentation Tool. yes that's the whole name, she's simple like that. 👑

🌸 SYNOPSIS 🌸

valadoc [OPTION]... FILE...

🦋 DESCRIPTION 🦋

valadoc is a documentation generator. she makes API documentation out of Vala source code, and she's built on top of libvala. that's the whole vibe. 💅

💫 Usage:

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

🎀 Help Options:

  • -h, --help — shows you the help options. the classic. when in doubt, ask her nicely. 🫶

🌈 Application Options:

  • -o, --directory=DIRECTORY — the output directory. where the docs go to live. 🏠
  • -b, --basedir=DIRECTORY — the base source directory.
  • -D, --define=SYMBOL... — define a SYMBOL. yes you can do it multiple times, go off.
  • --profile=PROFILE — minimum runtime dependency, bestie. your choices are 'gobject' (that's the default) or 'posix' (which is the minimal libc situation).
  • --enable-experimental — turns on experimental features. living dangerously, i respect it. 🙈
  • --enable-experimental-non-null — turns on the experimental enhancements for non-null types. spicy.
  • --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 the binding for PACKAGE.
  • --driver — name of a driver, or a path to a custom driver. > ⚠️ heads up: this one is DEPRECATED AND IGNORED. she's giving ghosting. 💀
  • --importdir=DIRECTORY... — look for external documentation in DIRECTORY.
  • --import=PACKAGE... — include the binding for PACKAGE.
  • --alternative-resource-dir=DIRECTORY... — alternative resource directories.
  • --wiki=DIRECTORY — wiki directory.
  • --deps — adds packages to the documentation.
  • --doclet=PLUGIN — the name of an included doclet, or a path to a custom doclet.
  • -X, --doclet-arg=ARG — pass arguments to the doclet. middleman energy but make it useful. 💅
  • --no-protected — removes protected elements from the documentation.
  • --internal — adds internal elements to the documentation.
  • --private — adds private elements to the documentation.
  • --use-svg-images — generate SVG image charts instead of PNG. vector girlies stay winning. ✨
  • --package-name=NAME — the package name.
  • --package-version=VERSION — the package version.
  • --gir=NAME-VERSION.gir — the GObject-Introspection repository file name.
  • --version — displays the version number.
  • --force — force.
  • --fatal-warnings — treats warnings as fatal. no chill mode activated. 😭
  • --verbose — shows all warnings.
  • --no-color — disables colored output. (a tragedy, but okay. 💔)
  • --target-glib='MAJOR.MINOR', or 'auto' — the target version of glib for code generation.

💀 BUGS 💀

found a bug? not the cute kind? take it here:

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

🫶 HOMEPAGE OR CONTACT 🫶

https://docs.vala.dev

👑 AUTHORS 👑

Florian Brosch — the icon, the moment, the legend. 🌟

and that's the whole page bestie, periodt 💖 this was Valadoc 0.56.19, March 2026, manual section VALADOC(1) — now go document something iconic. 🌸🦋✨

📦 where this page comes from