1/* settings.vala
2 *
3 * Copyright (C) 2008-2009 Florian Brosch
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
18 *
19 * Author:
20 * 	Brosch Florian <flo.brosch@gmail.com>
21 */
22
23
24/**
25 * Contains information about output settings configuration
26 */
27public class Valadoc.Settings : Object {
28	/**
29	 * Output directory/file name.
30	 */
31	public string path = "documentation/";
32
33	/**
34	 * Package name
35	 */
36	public string pkg_name = null;
37
38	/**
39	 * Package version
40	 */
41	public string pkg_version;
42
43	/**
44	 * Wiki directory
45	 */
46	public string wiki_directory;
47
48	/**
49	 * Plugin-specific command line arguments
50	 */
51	public string[] pluginargs;
52
53
54	/**
55	 * Add private elements to documentation
56	 */
57	public bool _private = false;
58
59	/**
60	 * Add protected elements to documentation
61	 */
62	public bool _protected = false;
63
64	/**
65	 * Add internal elements to documentation
66	 */
67	public bool _internal = false;
68
69	/**
70	 * Add dependencies to the documentation
71	 */
72	public bool with_deps = false;
73
74	public bool add_inherited = false;
75
76	/**
77	 * Show all warnings
78	 */
79	public bool verbose = false;
80
81
82
83	/**
84	 * Do not warn when using experimental features.
85	 */
86	public bool experimental;
87
88	/**
89	 * Enable experimental enhancements for non-null types.
90	 */
91	public bool experimental_non_null;
92
93	/**
94	 * Use the given profile (dova, gobject, posix, ...) instead of the defaul
95	 */
96	public string? profile;
97
98	/**
99	 * Base source directory.
100	 */
101	public string? basedir;
102
103	/**
104	 * Output directory/file name.
105	 */
106	public string? directory;
107
108
109	/**
110	 * A list of defined symbols.
111	 */
112	public string[] defines;
113
114	/**
115	 * List of directories where to find .vapi files.
116	 */
117	public string[] vapi_directories;
118
119	/**
120	 * A list of all packages
121	 */
122	public string[] packages;
123
124	/**
125	 * A list of all source files.
126	 */
127	public string[] source_files;
128
129	/**
130	 * GObject-Introspection directory
131	 */
132	public string? gir_directory;
133
134	/**
135	 * GObject-Introspection repository file name
136	 */
137	public string? gir_name;
138
139	/**
140	 * A list of all metadata directories
141	 */
142	public string[] metadata_directories;
143
144	/**
145	 * Alternative paths for resources
146	 */
147	public string[] alternative_resource_dirs;
148
149	/**
150	 * A list of all gir directories.
151	 */
152	public string[] gir_directories;
153
154	/**
155	 * GLib version to target.
156	 */
157	public string target_glib;
158
159	public string gir_namespace;
160
161	public string gir_version;
162
163	/**
164	 * Use SVG as chart images
165	 */
166	public bool use_svg_images = false;
167}
168
169
170