summaryrefslogtreecommitdiff
path: root/glib/src/glib_docs_override.xml
blob: a64a435ccc02fb8c0248ad546527cacd5ec620a4 (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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
<root>
  <substitute_type_name from="GBindingFlags" to="Glib::Binding::Flags" />
  <substitute_type_name from="GChecksumType" to="Glib::Checksum::Type" />
  <substitute_type_name from="GDateMonth" to="Glib::Date::Month" />
  <substitute_type_name from="GDateWeekday" to="Glib::Date::Weekday" />
  <substitute_type_name from="GDateDMY" to="Glib::Date::DMY" />
  <substitute_type_name from="GKeyFileFlags" to="Glib::KeyFile::Flags" />
  <substitute_type_name from="GMarkupParseFlags" to="Glib::Markup::ParseFlags" />
  <substitute_type_name from="GModuleFlags" to="Glib::Module::Flags" />
  <substitute_type_name from="GRegexCompileFlags" to="Glib::Regex::CompileFlags" />
  <substitute_type_name from="GRegexMatchFlags" to="Glib::Regex::MatchFlags" />

  <substitute_enumerator_name from_prefix="G_BINDING_" to_prefix="Glib::Binding::Flags::" />
  <substitute_enumerator_name from_prefix="G_DATE_" to_prefix="Glib::Date::" />
  <substitute_enumerator_name from_prefix="G_PARAM_" to_prefix="Glib::ParamFlags::" />
  <substitute_enumerator_name from_prefix="G_REGEX_MATCH_" to_prefix="Glib::Regex::MatchFlags::" />
  <substitute_enumerator_name from_prefix="G_REGEX_" to_prefix="Glib::Regex::CompileFlags::" />
  <substitute_enumerator_name from_prefix="G_SPAWN_ERROR_" to_prefix="Glib::SpawnError::" />
  <substitute_enumerator_name from_prefix="G_TIME_TYPE_" to_prefix="Glib::TimeType::" />
  <substitute_enumerator_name from_prefix="G_UNICODE_BREAK_" to_prefix="Glib::UnicodeBreakType::" />
  <substitute_enumerator_name from_prefix="G_NORMALIZE_" to_prefix="Glib::NormalizeMode::" />
  <substitute_enumerator_name from="G_FILE_ERROR" to="Glib::FileError" />
  <substitute_enumerator_name from="G_KEY_FILE_ERROR" to="Glib::KeyFileError" />
  <substitute_enumerator_name from_prefix="G_KEY_FILE_ERROR_" to_prefix="Glib::KeyFileError::" />
  <!-- enum GOptionArg is not wrapped. Don't substitute. -->
  <substitute_enumerator_name from_prefix="G_OPTION_ARG_" to_prefix="G_OPTION_ARG_" />
  <!-- These are preprocessor defines. Don't substitute. -->
  <substitute_enumerator_name from="G_PARAM_STATIC_STRINGS" to="G_PARAM_STATIC_STRINGS" />
  <substitute_enumerator_name from_prefix="G_VARIANT_TYPE_" to_prefix="G_VARIANT_TYPE_" />

    <function name="g_option_context_set_summary">
    <parameters>
    <parameter name="context">
    <parameter_description> a #GOptionContext
    </parameter_description>
    </parameter>
            <parameter name="summary">
                <parameter_description> a string to be shown in --help output before the list of
                    options
                </parameter_description>
            </parameter>
        </parameters>
        <return></return>
    </function>

    <function name="g_option_context_set_description">
        <parameters>
        <parameter name="context">
        <parameter_description> a #GOptionContext
        </parameter_description>
        </parameter>
            <parameter name="description">
                <parameter_description> a string to be shown in --help output
                    after the list of options
                </parameter_description>
            </parameter>
        </parameters>
        <return></return>
    </function>

<function name="g_key_file_get_double">
<description>
Return value: the value associated with the key as a double.

Since: 2.14

\throw Glib::KeyFileError
</description>
</function>


<function name="g_key_file_load_from_file">
<description>
Loads a key file into an empty KeyFile instance.
If the file could not be loaded then a FileError or KeyFileError exception is thrown.

Since: 2.6

\throw Glib::FileError
\throw Glib::KeyFileError
</description>
</function>


<function name="g_key_file_get_value">
<description>
Returns the value associated with @key under @group_name.

Since: 2.6

\throw Glib::KeyFileError in the event the key cannot be found (with the Glib::KeyFileError::KEY_NOT_FOUND code).
\throw Glib::KeyFileError in the event that the @group_name cannot be found (with the Glib::KeyFileError::GROUP_NOT_FOUND code).
</description>
<return> The value as a string.
</return>
</function>

<function name="g_key_file_get_comment">
<description>
Retrieves a comment above @key from @group_name.
If @key is %NULL then @comment will be read from above 
@group_name. If both @key and @group_name are %NULL, then 
@comment will be read from above the first group in the file.
Use the overrides for a %NULL @key or @group.

Since: 2.6

\throw Glib::KeyFileError
</description>
<parameters>
<parameter name="key_file">
<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
<parameter name="group_name">
<parameter_description> a group name
</parameter_description>
</parameter>
<parameter name="key">
<parameter_description> a key
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
<return> The comment
</return>
</function>

<function name="g_key_file_set_comment">
<description>
Places a comment above @key from @group_name.
If @key is %NULL then @comment will be written above @group_name.  
If both @key and @group_name  are %NULL, then @comment will be 
written above the first group in the file.

\throw Glib::KeyFileError
</description>
<return></return>
</function>

<function name="g_key_file_remove_comment">
<description>
Removes a comment above @key from @group_name.
If @key is %NULL then @comment will be removed above @group_name. 
If both @key and @group_name are %NULL, then @comment will
be removed above the first group in the file.

\throw Glib::KeyFileError
</description>
<return></return>
</function>

<function name="g_key_file_has_key">
<description>
Looks whether the key file has the key @key in the group
@group_name. 

Since: 2.6

\throw Glib::KeyFileError
</description>
</function>

<function name="g_key_file_get_string">
<description>
Return value: a newly allocated string or %NULL.

Since: 2.6

\throw Glib::KeyFileError
</description>
</function>

<function name="g_key_file_get_locale_string">
<description>
Return value: a newly allocated string or %NULL.

Since: 2.6

\throw Glib::KeyFileError
</description>
</function>

<function name="g_key_file_get_boolean">
<description>
Return value: the value associated with the key as a boolean.

Since: 2.6

\throw Glib::KeyFileError
</description>
</function>

<function name="g_key_file_get_integer">
<description>
Return value: the value associated with the key as an integer.

Since: 2.6

\throw Glib::KeyFileError
</description>
</function>

<function name="g_key_file_remove_group">
<description>
Removes the specified group, @group_name, 
from the key file. 

\throw Glib::KeyFileError
</description>
<return></return>
</function>

<function name="g_key_file_remove_key">
<description>
Removes @key in @group_name from the key file. 

\throw Glib::KeyFileError
</description>
<return></return>
</function>

</root>