1VALADOC(1)                       User Commands                      VALADOC(1)
2
3
4

NAME

6       valadoc - Vala Documentation Tool
7

SYNOPSIS

9       valadoc [OPTION]... FILE...
10

DESCRIPTION

12       Valadoc  is  a documentation generator for generating API documentation
13       from Vala source code based on libvala.
14
15   Usage:
16              valadoc [OPTION?] FILE... - Vala Documentation Tool
17
18   Help Options:
19       -h, --help
20              Show help options
21
22   Application Options:
23       -o, --directory=DIRECTORY
24              Output directory
25
26       -b, --basedir=DIRECTORY
27              Base source directory
28
29       -D, --define=SYMBOL...
30              Define SYMBOL
31
32       --profile=PROFILE
33              Minimum runtime dependency: 'gobject' (default) or 'posix' (min‐
34              imal libc)
35
36       --enable-experimental
37              Enable experimental features
38
39       --enable-experimental-non-null
40              Enable experimental enhancements for non-null types
41
42       --metadatadir=DIRECTORY...
43              Look for GIR .metadata files in DIRECTORY
44
45       --girdir=DIRECTORY...
46              Look for .gir files in DIRECTORY
47
48       --vapidir=DIRECTORY...
49              Look for package bindings in DIRECTORY
50
51       --pkg=PACKAGE...
52              Include binding for PACKAGE
53
54       --driver
55              Name of an driver or path to a custom driver (DEPRECATED AND IG‐
56              NORED)
57
58       --importdir=DIRECTORY...
59              Look for external documentation in DIRECTORY
60
61       --import=PACKAGE...
62              Include binding for PACKAGE
63
64       --alternative-resource-dir=DIRECTORY...
65              Alternative resource directories
66
67       --wiki=DIRECTORY
68              Wiki directory
69
70       --deps Adds packages to the documentation
71
72       --doclet=PLUGIN
73              Name of an included doclet or path to custom doclet
74
75       -X, --doclet-arg=ARG
76              Pass arguments to the doclet
77
78       --no-protected
79              Removes protected elements from documentation
80
81       --internal
82              Adds internal elements to documentation
83
84       --private
85              Adds private elements to documentation
86
87       --use-svg-images
88              Generate SVG image charts instead of PNG
89
90       --package-name=NAME
91              package name
92
93       --package-version=VERSION
94              package version
95
96       --gir=NAME-VERSION.gir
97              GObject-Introspection repository file name
98
99       --version
100              Display version number
101
102       --force
103              force
104
105       --fatal-warnings
106              Treat warnings as fatal
107
108       --verbose
109              Show all warnings
110
111       --no-color
112              Disable colored output
113
114       --target-glib='MAJOR.MINOR', or 'auto'
115              Target version of glib for code generation
116

BUGS

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

HOMEPAGE OR CONTACT

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

AUTHORS

124       Florian Brosch
125
126
127
128Valadoc 0.56.14                  November 2023                      VALADOC(1)