1. Manuals
  2. Tumbleweed
  3. valadoc
  4. valadoc-0.56(1)

Scroll to navigation

VALADOC(1) User Commands VALADOC(1)

NAME

valadoc - Vala Documentation Tool

SYNOPSIS

valadoc [OPTION]... FILE...

DESCRIPTION

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:

Show help options

Application Options:

Output directory
Base source directory
Define SYMBOL
Minimum runtime dependency: 'gobject' (default) or 'posix' (minimal libc)
Enable experimental features
Enable experimental enhancements for non-null types
Look for GIR .metadata files in DIRECTORY
Look for .gir files in DIRECTORY
Look for package bindings in DIRECTORY
Include binding for PACKAGE
Name of an driver or path to a custom driver (DEPRECATED AND IGNORED)
Look for external documentation in DIRECTORY
Include binding for PACKAGE
Alternative resource directories
Wiki directory
Adds packages to the documentation
Name of an included doclet or path to custom doclet
Pass arguments to the doclet
Removes protected elements from documentation
Adds internal elements to documentation
Adds private elements to documentation
Generate SVG image charts instead of PNG
package name
package version
GObject-Introspection repository file name
Display version number
force
Treat warnings as fatal
Show all warnings
Disable colored output
Target version of glib for code generation

BUGS

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

HOMEPAGE OR CONTACT

https://wiki.gnome.org/Projects/Valadoc

AUTHORS

Florian Brosch

April 2024 Valadoc 0.56.17