settings.vala 3.06 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
/* 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,
Florian Brosch's avatar
Florian Brosch committed
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 13 14 15 16 17 18 19 20
 * 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>
Florian Brosch's avatar
Florian Brosch committed
21 22
 */

23 24 25 26

/**
 * Contains information about output settings configuration
 */
Florian Brosch's avatar
Florian Brosch committed
27
public class Valadoc.Settings : Object {
28 29 30
	/**
	 * Output directory/file name.
	 */
Florian Brosch's avatar
Florian Brosch committed
31
	public string path = "documentation/";
32 33 34 35

	/**
	 * Package name
	 */
36
	public string pkg_name = null;
37 38 39 40

	/**
	 * Package version
	 */
41
	public string pkg_version;
42 43 44 45

	/**
	 * Wiki directory
	 */
46
	public string wiki_directory;
47 48 49 50

	/**
	 * Plugin-specific command line arguments
	 */
51
	public string[] pluginargs;
Florian Brosch's avatar
Florian Brosch committed
52

53 54 55 56

	/**
	 * Add private elements to documentation
	 */
Florian Brosch's avatar
Florian Brosch committed
57
	public bool _private = false;
58 59 60 61

	/**
	 * Add protected elements to documentation
	 */
Florian Brosch's avatar
Florian Brosch committed
62
	public bool _protected = false;
63 64 65 66

	/**
	 * Add internal elements to documentation
	 */
Florian Brosch's avatar
Florian Brosch committed
67
	public bool _internal = false;
68 69 70 71

	/**
	 * Add dependencies to the documentation
	 */
Florian Brosch's avatar
Florian Brosch committed
72
	public bool with_deps = false;
73

Florian Brosch's avatar
Florian Brosch committed
74
	public bool add_inherited = false;
75 76 77 78

	/**
	 * Show all warnings
	 */
79
	public bool verbose = false;
Florian Brosch's avatar
Florian Brosch committed
80

81 82 83 84 85


	/**
	 * Do not warn when using experimental features.
	 */
Florian Brosch's avatar
Florian Brosch committed
86
	public bool experimental;
87 88 89 90

	/**
	 * Enable experimental enhancements for non-null types.
	 */
91
	public bool experimental_non_null;
92 93 94 95

	/**
	 * Use the given profile (dova, gobject, posix, ...) instead of the defaul
	 */
Florian Brosch's avatar
Florian Brosch committed
96
	public string? profile;
97 98 99 100

	/**
	 * Base source directory.
	 */
Florian Brosch's avatar
Florian Brosch committed
101
	public string? basedir;
102 103 104 105

	/**
	 * Output directory/file name.
	 */
Florian Brosch's avatar
Florian Brosch committed
106 107
	public string? directory;

108 109 110 111

	/**
	 * A list of defined symbols.
	 */
Florian Brosch's avatar
Florian Brosch committed
112
	public string[] defines;
113 114 115 116

	/**
	 * List of directories where to find .vapi files.
	 */
Florian Brosch's avatar
Florian Brosch committed
117
	public string[] vapi_directories;
118 119 120 121 122 123 124 125 126 127

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

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

129 130 131 132 133 134 135 136 137
	/**
	 * GObject-Introspection directory
	 */
	public string? gir_directory;

	/**
	 * GObject-Introspection repository file name
	 */
	public string? gir_name;
138 139 140 141 142 143

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

Florian Brosch's avatar
Florian Brosch committed
144
	/**
Florian Brosch's avatar
Florian Brosch committed
145
	 * Alternative paths for resources
Florian Brosch's avatar
Florian Brosch committed
146
	 */
Florian Brosch's avatar
Florian Brosch committed
147
	public string[] alternative_resource_dirs;
Florian Brosch's avatar
Florian Brosch committed
148

149 150 151 152
	/**
	 * A list of all gir directories.
	 */
	public string[] gir_directories;
153

154 155 156 157 158
	/**
	 * GLib version to target.
	 */
	public string target_glib;

159 160 161
	public string gir_namespace;

	public string gir_version;
162 163 164 165 166

	/**
	 * Use SVG as chart images
	 */
	public bool use_svg_images = false;
Florian Brosch's avatar
Florian Brosch committed
167 168
}

169