1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5.
2 .TH VALADOC "1" "February 2018" "valadoc 0.39.91" "User Commands"
4 valadoc \- Vala Documentation Tool
7 [\fIOPTION\fR]... \fIFILE\fR...
9 Valadoc is a documentation generator for generating API documentation
10 from Vala source code based on libvala.
13 valadoc [OPTION?] FILE... \- Vala Documentation Tool
16 \fB\-h\fR, \fB\-\-help\fR
18 .SS "Application Options:"
20 \fB\-o\fR, \fB\-\-directory\fR=\fI\,DIRECTORY\/\fR
23 \fB\-b\fR, \fB\-\-basedir\fR=\fI\,DIRECTORY\/\fR
26 \fB\-D\fR, \fB\-\-define\fR=\fI\,SYMBOL\/\fR...
29 \fB\-\-profile\fR=\fI\,PROFILE\/\fR
30 Use the given profile instead of the default
32 \fB\-\-enable\-experimental\fR
33 Enable experimental features
35 \fB\-\-enable\-experimental\-non\-null\fR
36 Enable experimental enhancements for non\-null types
38 \fB\-\-metadatadir\fR=\fI\,DIRECTORY\/\fR...
39 Look for GIR .metadata files in DIRECTORY
41 \fB\-\-girdir\fR=\fI\,DIRECTORY\/\fR...
42 Look for .gir files in DIRECTORY
44 \fB\-\-vapidir\fR=\fI\,DIRECTORY\/\fR...
45 Look for package bindings in DIRECTORY
47 \fB\-\-pkg\fR=\fI\,PACKAGE\/\fR...
48 Include binding for PACKAGE
51 Name of an driver or path to a custom driver
53 \fB\-\-importdir\fR=\fI\,DIRECTORY\/\fR...
54 Look for external documentation in DIRECTORY
56 \fB\-\-import\fR=\fI\,PACKAGE\/\fR...
57 Include binding for PACKAGE
59 \fB\-\-alternative\-resource\-dir\fR=\fI\,DIRECTORY\/\fR...
60 Alternative resource directories
62 \fB\-\-wiki\fR=\fI\,DIRECTORY\/\fR
66 Adds packages to the documentation
68 \fB\-\-doclet\fR=\fI\,PLUGIN\/\fR
69 Name of an included doclet or path to custom doclet
71 \fB\-X\fR, \fB\-\-doclet\-arg\fR=\fI\,ARG\/\fR
72 Pass arguments to the doclet
74 \fB\-\-no\-protected\fR
75 Removes protected elements from documentation
78 Adds internal elements to documentation
81 Adds private elements to documentation
83 \fB\-\-use\-svg\-images\fR
84 Generate SVG image charts instead of PNG
86 \fB\-\-package\-name\fR=\fI\,NAME\/\fR
89 \fB\-\-package\-version\fR=\fI\,VERSION\/\fR
92 \fB\-\-gir\fR=\fI\,NAME\-VERSION\/\fR.gir
93 GObject\-Introspection repository file name
96 Display version number
105 Disable colored output
107 \fB\-\-target\-glib\fR=\fI\,MAJOR\/\fR.MINOR
108 Target version of glib for code generation
110 https://bugzilla.gnome.org/page.cgi?id=browse.html&product=valadoc
111 .SH "HOMEPAGE OR CONTACT"
112 https://wiki.gnome.org/Projects/Valadoc