annotate doc/libaudacious/tmpl/vfs.sgml @ 2034:c43fb0845b71 trunk

[svn] - update VFS documentation - include gtkdoc templates for libaudacious
author nenolod
date Mon, 04 Dec 2006 00:10:02 -0800
parents
children 53a3d5db6b58
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2034
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
1 <!-- ##### SECTION Title ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
2 VFS
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
3
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
4 <!-- ##### SECTION Short_Description ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
5 Stream-based I/O in Audacious
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
6
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
7 <!-- ##### SECTION Long_Description ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
8 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
9 Audacious uses the VFS subsystem for moving implementing types of streams.
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
10 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
11
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
12 <!-- ##### SECTION See_Also ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
13 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
14
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
15 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
16
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
17 <!-- ##### SECTION Stability_Level ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
18
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
19
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
20 <!-- ##### STRUCT VFSFile ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
21 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
22
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
23 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
24
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
25 @uri:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
26 @handle:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
27 @base:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
28
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
29 <!-- ##### STRUCT VFSConstructor ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
30 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
31
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
32 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
33
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
34 @uri_id:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
35 @vfs_fopen_impl:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
36 @vfs_fclose_impl:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
37 @vfs_fread_impl:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
38 @vfs_fwrite_impl:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
39 @vfs_getc_impl:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
40 @vfs_ungetc_impl:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
41 @vfs_fseek_impl:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
42 @vfs_rewind_impl:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
43 @vfs_ftell_impl:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
44 @vfs_feof_impl:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
45 @vfs_truncate_impl:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
46
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
47 <!-- ##### FUNCTION vfs_init ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
48 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
49
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
50 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
51
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
52 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
53
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
54
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
55 <!-- ##### FUNCTION vfs_fopen ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
56 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
57
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
58 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
59
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
60 @path:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
61 @mode:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
62 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
63
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
64
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
65 <!-- ##### FUNCTION vfs_fclose ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
66 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
67
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
68 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
69
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
70 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
71 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
72
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
73
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
74 <!-- ##### FUNCTION vfs_fread ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
75 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
76
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
77 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
78
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
79 @ptr:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
80 @size:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
81 @nmemb:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
82 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
83 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
84
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
85
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
86 <!-- ##### FUNCTION vfs_fwrite ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
87 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
88
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
89 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
90
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
91 @ptr:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
92 @size:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
93 @nmemb:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
94 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
95 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
96
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
97
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
98 <!-- ##### FUNCTION vfs_getc ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
99 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
100
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
101 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
102
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
103 @stream:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
104 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
105
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
106
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
107 <!-- ##### FUNCTION vfs_ungetc ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
108 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
109
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
110 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
111
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
112 @c:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
113 @stream:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
114 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
115
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
116
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
117 <!-- ##### FUNCTION vfs_fgets ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
118 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
119
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
120 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
121
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
122 @s:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
123 @n:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
124 @stream:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
125 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
126
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
127
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
128 <!-- ##### FUNCTION vfs_fseek ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
129 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
130
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
131 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
132
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
133 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
134 @offset:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
135 @whence:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
136 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
137
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
138
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
139 <!-- ##### FUNCTION vfs_rewind ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
140 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
141
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
142 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
143
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
144 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
145
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
146
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
147 <!-- ##### FUNCTION vfs_ftell ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
148 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
149
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
150 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
151
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
152 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
153 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
154
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
155
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
156 <!-- ##### FUNCTION vfs_feof ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
157 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
158
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
159 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
160
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
161 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
162 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
163
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
164
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
165 <!-- ##### FUNCTION vfs_file_test ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
166 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
167
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
168 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
169
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
170 @path:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
171 @test:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
172 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
173
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
174
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
175 <!-- ##### FUNCTION vfs_is_writeable ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
176 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
177
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
178 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
179
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
180 @path:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
181 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
182
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
183
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
184 <!-- ##### FUNCTION vfs_truncate ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
185 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
186
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
187 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
188
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
189 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
190 @length:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
191 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
192
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
193
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
194 <!-- ##### FUNCTION vfs_fprintf ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
195 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
196
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
197 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
198
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
199 @stream:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
200 @format:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
201 @Varargs:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
202 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
203
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
204
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
205 <!-- ##### FUNCTION vfs_register_transport ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
206 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
207
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
208 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
209
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
210 @vtable:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
211 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
212
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
213