On Mon, 04 Mar 2013 23:30:16 +0100, Diego Biurrun <[email protected]> wrote:
> On Mon, Mar 04, 2013 at 11:35:07AM +0100, Anton Khirnov wrote:
> > --- a/libavcodec/avcodec.h
> > +++ b/libavcodec/avcodec.h
> > @@ -3455,6 +3470,19 @@ void av_shrink_packet(AVPacket *pkt, int size);
> >  int av_grow_packet(AVPacket *pkt, int grow_by);
> >  
> >  /**
> > + * Initialize a reference-counted packet from av_malloc()ed data.
> > + *
> > + * @param pkt packet to be initialized. This function will set the data, 
> > size,
> > + * buf and destruct fields, all others are left untouched.
> > + * @param data Data allocated by av_malloc() to be used as packet data. If 
> > this
> > + * function returns successfully, the data is owned by the underlying 
> > AVBuffer.
> > + * The caller may not access the data through other means.
> > + * @param size size of data in bytes, without the padding. I.e. the full 
> > buffer
> > + * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
> > + */
> > +int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
> 
> Here - and in all your other doxygen really - please vertically align the
> parameter descriptions, it makes things considerably easier to read.
> 
> Also, the return value of the function could be documented.
> 

fixed

-- 
Anton Khirnov
_______________________________________________
libav-devel mailing list
[email protected]
https://lists.libav.org/mailman/listinfo/libav-devel

Reply via email to