[FFmpeg-cvslog] r25246 - trunk/cmdutils.h

[stefano]

Author: stefano
Date: Tue Sep 28 16:49:55 2010
New Revision: 25246

Log:
Make new doxy follows the agreed upon style and grammatical
conventions, for consistency with the rest of the documentation.

Modified:
   trunk/cmdutils.h

Modified: trunk/cmdutils.h
==============================================================================
--- trunk/cmdutils.h	Tue Sep 28 15:44:10 2010	(r25245)
+++ trunk/cmdutils.h	Tue Sep 28 16:49:55 2010	(r25246)
@@ -234,19 +234,19 @@ typedef struct {
 } PtsCorrectionContext;
 
 /**
- * Resets the state of the PtsCorrectionContext.
+ * Reset the state of the PtsCorrectionContext.
  */
 void init_pts_correction(PtsCorrectionContext *ctx);
 
 /**
- * Attempts to guess proper monotonic timestamps for decoded video frames
+ * Attempt to guess proper monotonic timestamps for decoded video frames
  * which might have incorrect times. Input timestamps may wrap around, in
  * which case the output will as well.
  *
- * @param pts The pts field of the decoded AVPacket, as passed through
+ * @param pts the pts field of the decoded AVPacket, as passed through
  * AVCodecContext.reordered_opaque
- * @param dts The dts field of the decoded AVPacket
- * @return One of the input values. May be AV_NOPTS_VALUE.
+ * @param dts the dts field of the decoded AVPacket
+ * @return one of the input values, may be AV_NOPTS_VALUE
  */
 int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);