summaryrefslogtreecommitdiff
path: root/libavcodec/thread.h
diff options
context:
space:
mode:
authorDiego Biurrun <diego@biurrun.de>2011-12-07 13:03:53 +0100
committerDiego Biurrun <diego@biurrun.de>2011-12-12 23:06:23 +0100
commit58c42af722cebecd86e340dc3ed9ec44b1fe4a55 (patch)
tree9541c2a43eb2f181d670c04e200a6bd43ad8d4fc /libavcodec/thread.h
parent8b494b7b2773eb45c0ed364e346602de0d578196 (diff)
doxygen: misc consistency, spelling and wording fixes
Diffstat (limited to 'libavcodec/thread.h')
-rw-r--r--libavcodec/thread.h11
1 files changed, 5 insertions, 6 deletions
diff --git a/libavcodec/thread.h b/libavcodec/thread.h
index dfd261df1c..7f018fc441 100644
--- a/libavcodec/thread.h
+++ b/libavcodec/thread.h
@@ -31,15 +31,15 @@
#include "avcodec.h"
/**
- * Waits for decoding threads to finish and resets internal
- * state. Called by avcodec_flush_buffers().
+ * Wait for decoding threads to finish and reset internal state.
+ * Called by avcodec_flush_buffers().
*
* @param avctx The context.
*/
void ff_thread_flush(AVCodecContext *avctx);
/**
- * Submits a new frame to a decoding thread.
+ * Submit a new frame to a decoding thread.
* Returns the next available frame in picture. *got_picture_ptr
* will be 0 if none is available.
* The return value on success is the size of the consumed packet for
@@ -62,8 +62,7 @@ int ff_thread_decode_frame(AVCodecContext *avctx, AVFrame *picture,
void ff_thread_finish_setup(AVCodecContext *avctx);
/**
- * Notifies later decoding threads when part of their reference picture
- * is ready.
+ * Notify later decoding threads when part of their reference picture is ready.
* Call this when some part of the picture is finished decoding.
* Later calls with lower values of progress have no effect.
*
@@ -75,7 +74,7 @@ void ff_thread_finish_setup(AVCodecContext *avctx);
void ff_thread_report_progress(AVFrame *f, int progress, int field);
/**
- * Waits for earlier decoding threads to finish reference pictures
+ * Wait for earlier decoding threads to finish reference pictures.
* Call this before accessing some part of a picture, with a given
* value for progress, and it will return after the responsible decoding
* thread calls ff_thread_report_progress() with the same or