Browse code

document ff_get_line()

Originally committed as revision 24401 to svn://svn.ffmpeg.org/ffmpeg/trunk

Aurelien Jacobs authored on 2010/07/22 06:40:50
Showing 1 changed files
... ...
@@ -167,6 +167,17 @@ int ff_get_v_length(uint64_t val);
167 167
  */
168 168
 void ff_put_v(ByteIOContext *bc, uint64_t val);
169 169
 
170
+/**
171
+ * Read a whole line of text from ByteIOContext. Stop reading after reaching
172
+ * either a \n, a \0 or EOF. The returned string is always \0 terminated,
173
+ * and may be truncated if the buffer is too small.
174
+ *
175
+ * @param s the read-only ByteIOContext
176
+ * @param buf buffer to store the read line
177
+ * @param maxlen size of the buffer
178
+ * @return the length of the string written in the buffer, not including the
179
+ *         final \0
180
+ */
170 181
 int ff_get_line(ByteIOContext *s, char *buf, int maxlen);
171 182
 
172 183
 #define SPACE_CHARS " \t\r\n"