Fixes for #58195, based on some ideas from Hidetosh Tajima.
[platform/upstream/glib.git] / docs / reference / glib / tmpl / glib-unused.sgml
1 <!-- ##### ENUM GChannelError ##### -->
2 <para>
3
4 </para>
5
6 @G_CHANNEL_ERROR_ACCES: 
7 @G_CHANNEL_ERROR_BADF: 
8 @G_CHANNEL_ERROR_DEADLK: 
9 @G_CHANNEL_ERROR_FAULT: 
10 @G_CHANNEL_ERROR_INVAL: 
11 @G_CHANNEL_ERROR_IO: 
12 @G_CHANNEL_ERROR_ISDIR: 
13 @G_CHANNEL_ERROR_MFILE: 
14 @G_CHANNEL_ERROR_NOLCK: 
15 @G_CHANNEL_ERROR_NOSPC: 
16 @G_CHANNEL_ERROR_PERM: 
17 @G_CHANNEL_ERROR_PIPE: 
18 @G_CHANNEL_ERROR_SPIPE: 
19 @G_CHANNEL_ERROR_ENCODE_RW: 
20 @G_CHANNEL_ERROR_FAILED: 
21
22 <!-- ##### ENUM GChannelStatus ##### -->
23 <para>
24
25 </para>
26
27 @G_CHANNEL_STATUS_NORMAL: 
28 @G_CHANNEL_STATUS_EOF: 
29 @G_CHANNEL_STATUS_PARTIAL_CHARS: 
30 @G_CHANNEL_STATUS_AGAIN: 
31 @G_CHANNEL_STATUS_INTR: 
32 @G_CHANNEL_STATUS_ERROR: 
33 @G_CHANNEL_STATUS_BAD_INPUT: 
34
35 <!-- ##### USER_FUNCTION GCompareFuncData ##### -->
36 <para>
37
38 </para>
39
40 @a: 
41 @b: 
42 @user_data: 
43 @Returns: 
44
45 <!-- ##### USER_FUNCTION GCompletionStrcmpFunc ##### -->
46 <para>
47
48 </para>
49
50 @s1: 
51 @s2: 
52 @Returns: 
53
54 <!-- ##### USER_FUNCTION GErrorFunc ##### -->
55 <para>
56 Specifies the type of function passed to g_set_error_handler().
57 </para>
58
59 @str: the error message.
60
61 <!-- ##### USER_FUNCTION GHookFreeFunc ##### -->
62 <para>
63
64 </para>
65
66 @hook_list: 
67 @hook: 
68
69 <!-- ##### ENUM GIOFileMode ##### -->
70 <para>
71
72 </para>
73
74 @G_IO_FILE_MODE_READ: 
75 @G_IO_FILE_MODE_WRITE: 
76 @G_IO_FILE_MODE_APPEND: 
77 @G_IO_FILE_MODE_READ_WRITE: 
78 @G_IO_FILE_MODE_READ_WRITE_TRUNCATE: 
79 @G_IO_FILE_MODE_READ_WRITE_APPEND: 
80
81 <!-- ##### USER_FUNCTION GWarningFunc ##### -->
82 <para>
83 Specifies the type of function passed to g_set_warning_handler().
84 </para>
85
86 @str: the warning message.
87
88 <!-- ##### MACRO G_CHANNEL_ERROR ##### -->
89 <para>
90
91 </para>
92
93
94 <!-- ##### MACRO G_HOOK_DEFERRED_DESTROY ##### -->
95 <para>
96
97 </para>
98
99
100 <!-- ##### MACRO G_IO_CHANNEL_DEFAULT_LINE_TERM ##### -->
101 <para>
102 One of %G_IO_CHANNEL_UNIX_LINE_TERM, %G_IO_CHANNEL_DOS_LINE_TERM,
103 or %G_IO_CHANNEL_MACINTOSH_LINE_TERM (unimplemented)
104 depending on the system type.
105 </para>
106
107
108 <!-- ##### MACRO G_IO_CHANNEL_DOS_LINE_TERM ##### -->
109 <para>
110
111 </para>
112
113
114 <!-- ##### MACRO G_IO_CHANNEL_ENCODE_RAW ##### -->
115 <para>
116 Encoding for nonbuffered IO. With this encoding, data must be
117 read using g_io_channel_read_chars(); the other functions will
118 not work.
119 </para>
120
121
122 <!-- ##### MACRO G_IO_CHANNEL_MACINTOSH_LINE_TERM ##### -->
123 <para>
124
125 </para>
126
127
128 <!-- ##### MACRO G_IO_CHANNEL_UNIX_LINE_TERM ##### -->
129 <para>
130
131 </para>
132
133
134 <!-- ##### MACRO access ##### -->
135 <para>
136
137 </para>
138
139
140 <!-- ##### MACRO close ##### -->
141 <para>
142
143 </para>
144
145
146 <!-- ##### MACRO fdopen ##### -->
147 <para>
148
149 </para>
150
151
152 <!-- ##### FUNCTION g_channel_error_from_errno ##### -->
153 <para>
154
155 </para>
156
157 @en: 
158 @Returns: 
159
160 <!-- ##### FUNCTION g_channel_error_quark ##### -->
161 <para>
162
163 </para>
164
165 @Returns: 
166
167 <!-- ##### FUNCTION g_convert_error_quark ##### -->
168 <para>
169
170 </para>
171
172 @Returns: 
173
174 <!-- ##### FUNCTION g_main_add_poll ##### -->
175 <para>
176 Adds a file descriptor to be polled.
177 This is usually combined with g_source_add() to add an event source.
178 The event source's check function will typically test the revents
179 field in the #GPollFD struct and return TRUE if events need to be processed.
180 </para>
181
182 @fd: a #GPollFD, which is a file descriptor together with a bitwise
183 combination of #GIOCondition flags determining which events to poll for.
184 @priority: the priority of the poll, which should be the same as the priority
185 used for g_source_add() to ensure that the file descriptor is polled whenever
186 the results may be needed.
187 See #G_PRIORITY_DEFAULT, #G_PRIORITY_DEFAULT_IDLE, #G_PRIORITY_HIGH,
188 #G_PRIORITY_HIGH_IDLE, and #G_PRIORITY_LOW.
189
190 <!-- ##### FUNCTION g_main_context_get ##### -->
191 <para>
192
193 </para>
194
195 @thread: 
196 @Returns: 
197
198 <!-- ##### FUNCTION g_main_loop_destroy ##### -->
199 <para>
200
201 </para>
202
203 @loop: 
204
205 <!-- ##### FUNCTION g_main_remove_poll ##### -->
206 <para>
207 Removes a file descriptor from the list being polled.
208 </para>
209
210 @fd: the #GPollFD to remove.
211
212 <!-- ##### FUNCTION g_main_win32_get_poll_func ##### -->
213 <para>
214
215 </para>
216
217 @Returns: 
218
219 <!-- ##### FUNCTION g_mem_check ##### -->
220 <para>
221 Checks if the given memory has already been freed. If it has it outputs
222 a warning message.
223 To use this function you must configure glib with the flag
224 '--enable-mem-check=yes' before compiling.
225 </para>
226
227 @mem: the memory to check.
228
229 <!-- ##### FUNCTION g_scanner_stat_mode ##### -->
230 <para>
231 Gets the file attributes.
232 This is the <structfield>st_mode</structfield> field from the
233 <structname>stat</structname> structure. See the <function>stat()</function>
234 documentation.
235 </para>
236
237 @filename: the file name.
238 @Returns: the file attributes.
239
240 <!-- ##### FUNCTION g_set_error_handler ##### -->
241 <para>
242 Sets the function to be called to handle error messages.
243 This function is deprecated in favour of the new logging facilities.
244 </para>
245
246 @func: the function to be called to handle error messages.
247 @Returns: the old error handler.
248
249 <!-- ##### FUNCTION g_set_message_handler ##### -->
250 <para>
251 Sets the function to be called to handle messages.
252 This function is deprecated in favour of the new logging facilities.
253 </para>
254
255 @func: the function to be called to handle normal messages.
256 @Returns: the old message handler.
257
258 <!-- ##### FUNCTION g_set_warning_handler ##### -->
259 <para>
260 Sets the function to be called to handle warning messages.
261 This function is deprecated in favour of the new logging facilities.
262 </para>
263
264 @func: the function to be called to handle warning messages.
265 @Returns: the old warning handler.
266
267 <!-- ##### FUNCTION g_source_add ##### -->
268 <para>
269 </para>
270
271 @priority: 
272 @can_recurse: 
273 @funcs: 
274 @source_data: 
275 @user_data: 
276 @notify: 
277 @Returns: 
278 @source: 
279 @context: 
280
281 <!-- ##### FUNCTION g_source_connect ##### -->
282 <para>
283
284 </para>
285
286 @source: 
287 @func: 
288 @data: 
289 @notify: 
290
291 <!-- ##### FUNCTION g_source_connect_indirect ##### -->
292 <para>
293
294 </para>
295
296 @source: 
297 @callback_data: 
298 @callback_funcs: 
299
300 <!-- ##### FUNCTION g_source_remove_by_source_data ##### -->
301 <para>
302 Removes the first event source found with the given source data.
303 </para>
304 <para>
305 Event sources are sorted with the highest priority first. Sources with equal
306 priority are stored in the order in which they were added.
307 </para>
308
309 @source_data: the source data, which contains information specific to the
310 type of source.
311 @Returns: TRUE if an event source was found and removed.
312
313 <!-- ##### FUNCTION g_static_private_get_for_thread ##### -->
314 <para>
315
316 </para>
317
318 @private_key: 
319 @thread: 
320 @Returns: 
321
322 <!-- ##### FUNCTION g_static_private_set_for_thread ##### -->
323 <para>
324
325 </para>
326
327 @private_key: 
328 @thread: 
329 @data: 
330 @notify: 
331
332 <!-- ##### MACRO g_string ##### -->
333 <para>
334 Turns the argument into a string literal by using the '#' stringizing operator.
335 </para>
336
337 @x: text to convert to a literal string.
338
339 <!-- ##### MACRO getcwd ##### -->
340 <para>
341
342 </para>
343
344
345 <!-- ##### MACRO getpid ##### -->
346 <para>
347
348 </para>
349
350
351 <!-- ##### MACRO lseek ##### -->
352 <para>
353
354 </para>
355
356
357 <!-- ##### MACRO open ##### -->
358 <para>
359
360 </para>
361
362
363 <!-- ##### MACRO pclose ##### -->
364 <para>
365
366 </para>
367
368
369 <!-- ##### MACRO popen ##### -->
370 <para>
371
372 </para>
373
374
375 <!-- ##### MACRO read ##### -->
376 <para>
377
378 </para>
379
380
381 <!-- ##### MACRO write ##### -->
382 <para>
383
384 </para>
385
386