[FFmpeg-devel] [PATCH 4/8] document ff_get_line()

[Aurelien Jacobs]

On Wed, Jul 21, 2010 at 04:33:28PM +0200, Michael Niedermayer wrote:
> On Wed, Jul 21, 2010 at 11:53:06AM +0200, Aurelien Jacobs wrote:
> > 
> > ---
> >  libavformat/internal.h |   11 +++++++++++
> >  1 files changed, 11 insertions(+), 0 deletions(-)
> > 
> > diff --git a/libavformat/internal.h b/libavformat/internal.h
> > index b746c1d..d601740 100644
> > --- a/libavformat/internal.h
> > +++ b/libavformat/internal.h
> > @@ -167,6 +167,17 @@ int ff_get_v_length(uint64_t val);
> >   */
> >  void ff_put_v(ByteIOContext *bc, uint64_t val);
> >  
> > +/**
> > + * Read a whole line of text from ByteIOContext. Stop reading after reaching
> > + * either a \n, a \0 or EOF. The returned string is always \0 terminated,
> > + * and may be truncated if the buffer is too small.
> > + *
> > + * @param s the read-only ByteIOContext
> > + * @param buf buffer to store the read line
> > + * @param maxlen size of the buffer
> 
> > + * @return the line of the string written in the buffer, not including the
> > + *         final \0
> 
> s/line/length/

Ooops... Yes.

> ok otherwise

applied

Aurel