1VALADOC(1) User Commands VALADOC(1)
2
3
4
6 valadoc - Vala Documentation Tool
7
9 valadoc [OPTION]... FILE...
10
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
55
56 --importdir=DIRECTORY...
57 Look for external documentation in DIRECTORY
58
59 --import=PACKAGE...
60 Include binding for PACKAGE
61
62 --alternative-resource-dir=DIRECTORY...
63 Alternative resource directories
64
65 --wiki=DIRECTORY
66 Wiki directory
67
68 --deps Adds packages to the documentation
69
70 --doclet=PLUGIN
71 Name of an included doclet or path to custom doclet
72
73 -X, --doclet-arg=ARG
74 Pass arguments to the doclet
75
76 --no-protected
77 Removes protected elements from documentation
78
79 --internal
80 Adds internal elements to documentation
81
82 --private
83 Adds private elements to documentation
84
85 --use-svg-images
86 Generate SVG image charts instead of PNG
87
88 --package-name=NAME
89 package name
90
91 --package-version=VERSION
92 package version
93
94 --gir=NAME-VERSION.gir
95 GObject-Introspection repository file name
96
97 --version
98 Display version number
99
100 --force
101 force
102
103 --verbose
104 Show all warnings
105
106 --no-color
107 Disable colored output
108
109 --target-glib=MAJOR.MINOR
110 Target version of glib for code generation
111
113 https://gitlab.gnome.org/GNOME/vala/issues
114
116 https://wiki.gnome.org/Projects/Valadoc
117
119 Florian Brosch
120
121
122
123valadoc 0.40.8 July 2018 VALADOC(1)