added some function documentations.
[platform/upstream/glib.git] / docs / reference / glib / tmpl / glib-unused.sgml
1 <!-- ##### FUNCTION g_source_connect_indirect ##### -->
2 <para>
3
4 </para>
5
6 @source: 
7 @callback_data: 
8 @callback_funcs: 
9
10 <!-- ##### MACRO popen ##### -->
11 <para>
12
13 </para>
14
15
16 <!-- ##### FUNCTION g_mem_check ##### -->
17 <para>
18 Checks if the given memory has already been freed. If it has it outputs
19 a warning message.
20 To use this function you must configure glib with the flag
21 '--enable-mem-check=yes' before compiling.
22 </para>
23
24 @mem: the memory to check.
25
26 <!-- ##### MACRO pclose ##### -->
27 <para>
28
29 </para>
30
31
32 <!-- ##### FUNCTION g_main_add_poll ##### -->
33 <para>
34 Adds a file descriptor to be polled.
35 This is usually combined with g_source_add() to add an event source.
36 The event source's check function will typically test the revents
37 field in the #GPollFD struct and return TRUE if events need to be processed.
38 </para>
39
40 @fd: a #GPollFD, which is a file descriptor together with a bitwise
41 combination of #GIOCondition flags determining which events to poll for.
42 @priority: the priority of the poll, which should be the same as the priority
43 used for g_source_add() to ensure that the file descriptor is polled whenever
44 the results may be needed.
45 See #G_PRIORITY_DEFAULT, #G_PRIORITY_DEFAULT_IDLE, #G_PRIORITY_HIGH,
46 #G_PRIORITY_HIGH_IDLE, and #G_PRIORITY_LOW.
47
48 <!-- ##### MACRO lseek ##### -->
49 <para>
50
51 </para>
52
53
54 <!-- ##### MACRO getpid ##### -->
55 <para>
56
57 </para>
58
59
60 <!-- ##### FUNCTION g_source_remove_by_source_data ##### -->
61 <para>
62 Removes the first event source found with the given source data.
63 </para>
64 <para>
65 Event sources are sorted with the highest priority first. Sources with equal
66 priority are stored in the order in which they were added.
67 </para>
68
69 @source_data: the source data, which contains information specific to the
70 type of source.
71 @Returns: TRUE if an event source was found and removed.
72
73 <!-- ##### MACRO close ##### -->
74 <para>
75
76 </para>
77
78
79 <!-- ##### FUNCTION g_source_add ##### -->
80 <para>
81 </para>
82
83 @priority: 
84 @can_recurse: 
85 @funcs: 
86 @source_data: 
87 @user_data: 
88 @notify: 
89 @Returns: 
90 @source: 
91 @context: 
92
93 <!-- ##### MACRO fdopen ##### -->
94 <para>
95
96 </para>
97
98
99 <!-- ##### USER_FUNCTION GCompletionStrcmpFunc ##### -->
100 <para>
101
102 </para>
103
104 @s1: 
105 @s2: 
106 @Returns: 
107
108 <!-- ##### FUNCTION g_source_connect ##### -->
109 <para>
110
111 </para>
112
113 @source: 
114 @func: 
115 @data: 
116 @notify: 
117
118 <!-- ##### MACRO getcwd ##### -->
119 <para>
120
121 </para>
122
123
124 <!-- ##### MACRO write ##### -->
125 <para>
126
127 </para>
128
129
130 <!-- ##### FUNCTION g_main_remove_poll ##### -->
131 <para>
132 Removes a file descriptor from the list being polled.
133 </para>
134
135 @fd: the #GPollFD to remove.
136
137 <!-- ##### MACRO access ##### -->
138 <para>
139
140 </para>
141
142
143 <!-- ##### MACRO g_string ##### -->
144 <para>
145 Turns the argument into a string literal by using the '#' stringizing operator.
146 </para>
147
148 @x: text to convert to a literal string.
149
150 <!-- ##### FUNCTION g_main_win32_get_poll_func ##### -->
151 <para>
152
153 </para>
154
155 @Returns: 
156
157 <!-- ##### MACRO read ##### -->
158 <para>
159
160 </para>
161
162
163 <!-- ##### FUNCTION g_main_loop_destroy ##### -->
164 <para>
165
166 </para>
167
168 @loop: 
169
170 <!-- ##### FUNCTION g_convert_error_quark ##### -->
171 <para>
172
173 </para>
174
175 @Returns: 
176
177 <!-- ##### MACRO open ##### -->
178 <para>
179
180 </para>
181
182