Move the Doxygen function documentation unaltered from libavcodec/utils.c to
authorPanagiotis Issaris <takis.issaris@uhasselt.be>
Thu, 22 Feb 2007 19:05:44 +0000 (19:05 +0000)
committerPanagiotis Issaris <takis.issaris@uhasselt.be>
Thu, 22 Feb 2007 19:05:44 +0000 (19:05 +0000)
libavcodec/avcodec.h.

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

libavcodec/avcodec.h
libavcodec/utils.c

index 4afa4135aaf169828c9b69541a186c102be5309f..7fe1562ede68407a8e788a27125ba266cb795fbf 100644 (file)
@@ -2700,6 +2700,10 @@ int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
                          int *got_picture_ptr,
                          uint8_t *buf, int buf_size);
+
+/* decode a subtitle message. return -1 if error, otherwise return the
+   *number of bytes used. If no subtitle could be decompressed,
+   *got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
                             int *got_sub_ptr,
                             const uint8_t *buf, int buf_size);
@@ -2750,6 +2754,9 @@ int avcodec_close(AVCodecContext *avctx);
 
 void avcodec_register_all(void);
 
+/**
+ * Flush buffers, should be called when seeking or when switching to a different stream.
+ */
 void avcodec_flush_buffers(AVCodecContext *avctx);
 
 void avcodec_default_free_buffers(AVCodecContext *s);
@@ -2876,11 +2883,28 @@ extern AVBitStreamFilter mjpega_dump_header_bsf;
 
 
 /* memory */
+
+/**
+ * realloc which does nothing if the block is large enough
+ */
 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
+
 /* for static data only */
-/* call av_free_static to release all staticaly allocated tables */
+
+/**
+ * free all static arrays and reset pointers to 0.
+ * call av_free_static to release all staticaly allocated tables
+ */
 void av_free_static(void);
+
+/**
+ * allocation of static arrays - do not use for normal allocation.
+ */
 void *av_mallocz_static(unsigned int size);
+
+/**
+ * same as above, but does realloc
+ */
 void *av_realloc_static(void *ptr, unsigned int size);
 
 void img_copy(AVPicture *dst, const AVPicture *src,
index 60a978778ca9ac98b35a5cb6672bb5a593078a23..5058420ee410eeb0ea337a7a61873508bee0210c 100644 (file)
@@ -59,9 +59,6 @@ const uint8_t ff_reverse[256]={
 
 static int volatile entangled_thread_counter=0;
 
-/**
- * realloc which does nothing if the block is large enough
- */
 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size)
 {
     if(min_size < *size)
@@ -76,9 +73,6 @@ static unsigned int last_static = 0;
 static unsigned int allocated_static = 0;
 static void** array_static = NULL;
 
-/**
- * allocation of static arrays - do not use for normal allocation.
- */
 void *av_mallocz_static(unsigned int size)
 {
     void *ptr = av_mallocz(size);
@@ -93,10 +87,6 @@ void *av_mallocz_static(unsigned int size)
     return ptr;
 }
 
-/**
- * same as above, but does realloc
- */
-
 void *av_realloc_static(void *ptr, unsigned int size)
 {
     int i;
@@ -113,9 +103,6 @@ void *av_realloc_static(void *ptr, unsigned int size)
 
 }
 
-/**
- * free all static arrays and reset pointers to 0.
- */
 void av_free_static(void)
 {
     while(last_static){
@@ -938,10 +925,6 @@ int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
 }
 #endif
 
-
-/* decode a subtitle message. return -1 if error, otherwise return the
-   *number of bytes used. If no subtitle could be decompressed,
-   *got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
                             int *got_sub_ptr,
                             const uint8_t *buf, int buf_size)
@@ -1206,9 +1189,6 @@ void avcodec_init(void)
     init_crcs();
 }
 
-/**
- * Flush buffers, should be called when seeking or when switching to a different stream.
- */
 void avcodec_flush_buffers(AVCodecContext *avctx)
 {
     if(avctx->codec->flush)