summaryrefslogtreecommitdiff
path: root/libvaladoc/settings.vala
blob: 67ef42aa02b6dd732f1bf61f657b7d2b1159ad52 (plain)
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/* settings.vala
 *
 * Copyright (C) 2008-2009 Florian Brosch
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
 *
 * Author:
 * 	Brosch Florian <flo.brosch@gmail.com>
 */


/**
 * Contains information about output settings configuration
 */
public class Valadoc.Settings : Object {
	/**
	 * Output directory/file name.
	 */
	public string path = "documentation/";

	/**
	 * Package name
	 */
	public string pkg_name = null;

	/**
	 * Package version
	 */
	public string pkg_version;

	/**
	 * Wiki directory
	 */
	public string wiki_directory;

	/**
	 * Plugin-specific command line arguments
	 */
	public string[] pluginargs;


	/**
	 * Add private elements to documentation
	 */
	public bool _private = false;

	/**
	 * Add protected elements to documentation
	 */
	public bool _protected = false;

	/**
	 * Add internal elements to documentation
	 */
	public bool _internal = false;

	/**
	 * Add dependencies to the documentation
	 */
	public bool with_deps = false;

	public bool add_inherited = false;

	/**
	 * Show all warnings
	 */
	public bool verbose = false;



	/**
	 * Do not warn when using experimental features.
	 */
	public bool experimental;

	/**
	 * Enable experimental enhancements for non-null types.
	 */
	public bool experimental_non_null;

	/**
	 * Use the given profile (gobject, posix, ...) instead of the default
	 */
	public Vala.Profile profile;

	/**
	 * Base source directory.
	 */
	public string? basedir;

	/**
	 * Output directory/file name.
	 */
	public string? directory;


	/**
	 * A list of defined symbols.
	 */
	public string[] defines;

	/**
	 * List of directories where to find .vapi files.
	 */
	public string[] vapi_directories;

	/**
	 * A list of all packages
	 */
	public string[] packages;

	/**
	 * A list of all source files.
	 */
	public string[] source_files;

	/**
	 * GObject-Introspection directory
	 */
	public string? gir_directory;

	/**
	 * GObject-Introspection repository file name
	 */
	public string? gir_name;

	/**
	 * A list of all metadata directories
	 */
	public string[] metadata_directories;

	/**
	 * Alternative paths for resources
	 */
	public string[] alternative_resource_dirs;

	/**
	 * A list of all gir directories.
	 */
	public string[] gir_directories;

	/**
	 * GLib version to target.
	 */
	public string target_glib;

	public string gir_namespace;

	public string gir_version;

	/**
	 * Use SVG as chart images
	 */
	public bool use_svg_images = false;
}