1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.5.
.TH VALADOC "1" "January 2022" "Valadoc 0.48.22" "User Commands"
.SH NAME
valadoc \- Vala Documentation Tool
.SH SYNOPSIS
.B valadoc
[\fIOPTION\fR]... \fIFILE\fR...
.SH DESCRIPTION
Valadoc is a documentation generator for generating API documentation
from Vala source code based on libvala.
.SS "Usage:"
.IP
valadoc [OPTION?] FILE... \- Vala Documentation Tool
.SS "Help Options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
Show help options
.SS "Application Options:"
.TP
\fB\-o\fR, \fB\-\-directory\fR=\fI\,DIRECTORY\/\fR
Output directory
.TP
\fB\-b\fR, \fB\-\-basedir\fR=\fI\,DIRECTORY\/\fR
Base source directory
.TP
\fB\-D\fR, \fB\-\-define\fR=\fI\,SYMBOL\/\fR...
Define SYMBOL
.TP
\fB\-\-profile\fR=\fI\,PROFILE\/\fR
Use the given profile instead of the default
.TP
\fB\-\-enable\-experimental\fR
Enable experimental features
.TP
\fB\-\-enable\-experimental\-non\-null\fR
Enable experimental enhancements for non\-null types
.TP
\fB\-\-metadatadir\fR=\fI\,DIRECTORY\/\fR...
Look for GIR .metadata files in DIRECTORY
.TP
\fB\-\-girdir\fR=\fI\,DIRECTORY\/\fR...
Look for .gir files in DIRECTORY
.TP
\fB\-\-vapidir\fR=\fI\,DIRECTORY\/\fR...
Look for package bindings in DIRECTORY
.TP
\fB\-\-pkg\fR=\fI\,PACKAGE\/\fR...
Include binding for PACKAGE
.TP
\fB\-\-driver\fR
Name of an driver or path to a custom driver (DEPRECATED AND IGNORED)
.TP
\fB\-\-importdir\fR=\fI\,DIRECTORY\/\fR...
Look for external documentation in DIRECTORY
.TP
\fB\-\-import\fR=\fI\,PACKAGE\/\fR...
Include binding for PACKAGE
.TP
\fB\-\-alternative\-resource\-dir\fR=\fI\,DIRECTORY\/\fR...
Alternative resource directories
.TP
\fB\-\-wiki\fR=\fI\,DIRECTORY\/\fR
Wiki directory
.TP
\fB\-\-deps\fR
Adds packages to the documentation
.TP
\fB\-\-doclet\fR=\fI\,PLUGIN\/\fR
Name of an included doclet or path to custom doclet
.TP
\fB\-X\fR, \fB\-\-doclet\-arg\fR=\fI\,ARG\/\fR
Pass arguments to the doclet
.TP
\fB\-\-no\-protected\fR
Removes protected elements from documentation
.TP
\fB\-\-internal\fR
Adds internal elements to documentation
.TP
\fB\-\-private\fR
Adds private elements to documentation
.TP
\fB\-\-use\-svg\-images\fR
Generate SVG image charts instead of PNG
.TP
\fB\-\-package\-name\fR=\fI\,NAME\/\fR
package name
.TP
\fB\-\-package\-version\fR=\fI\,VERSION\/\fR
package version
.TP
\fB\-\-gir\fR=\fI\,NAME\-VERSION\/\fR.gir
GObject\-Introspection repository file name
.TP
\fB\-\-version\fR
Display version number
.TP
\fB\-\-force\fR
force
.TP
\fB\-\-fatal\-warnings\fR
Treat warnings as fatal
.TP
\fB\-\-verbose\fR
Show all warnings
.TP
\fB\-\-no\-color\fR
Disable colored output
.TP
\fB\-\-target\-glib=\fR'MAJOR.MINOR', or 'auto'
Target version of glib for code generation
.SH BUGS
https://gitlab.gnome.org/GNOME/vala/issues
.SH "HOMEPAGE OR CONTACT"
https://wiki.gnome.org/Projects/Valadoc
.SH AUTHORS
Florian Brosch
|
