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              Use the given profile instead of the default
34
35       --enable-experimental
36              Enable experimental features
37
38       --enable-experimental-non-null
39              Enable experimental enhancements for non-null types
40
41       --metadatadir=DIRECTORY...
42              Look for GIR .metadata files in DIRECTORY
43
44       --girdir=DIRECTORY...
45              Look for .gir files in DIRECTORY
46
47       --vapidir=DIRECTORY...
48              Look for package bindings in DIRECTORY
49
50       --pkg=PACKAGE...
51              Include binding for PACKAGE
52
53       --driver
54              Name of an driver or path to a custom driver (DEPRECATED AND IG‐
55              NORED)
56
57       --importdir=DIRECTORY...
58              Look for external documentation in DIRECTORY
59
60       --import=PACKAGE...
61              Include binding for PACKAGE
62
63       --alternative-resource-dir=DIRECTORY...
64              Alternative resource directories
65
66       --wiki=DIRECTORY
67              Wiki directory
68
69       --deps Adds packages to the documentation
70
71       --doclet=PLUGIN
72              Name of an included doclet or path to custom doclet
73
74       -X, --doclet-arg=ARG
75              Pass arguments to the doclet
76
77       --no-protected
78              Removes protected elements from documentation
79
80       --internal
81              Adds internal elements to documentation
82
83       --private
84              Adds private elements to documentation
85
86       --use-svg-images
87              Generate SVG image charts instead of PNG
88
89       --package-name=NAME
90              package name
91
92       --package-version=VERSION
93              package version
94
95       --gir=NAME-VERSION.gir
96              GObject-Introspection repository file name
97
98       --version
99              Display version number
100
101       --force
102              force
103
104       --fatal-warnings
105              Treat warnings as fatal
106
107       --verbose
108              Show all warnings
109
110       --no-color
111              Disable colored output
112
113       --target-glib='MAJOR.MINOR', or 'auto'
114              Target version of glib for code generation
115

BUGS

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

HOMEPAGE OR CONTACT

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

AUTHORS

123       Florian Brosch
124
125
126
127Valadoc 0.48.17                   April 2021                        VALADOC(1)