Browse code

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

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

Stefano Sabatini authored on 2010/09/28 23:49:55
Showing 1 changed files
... ...
@@ -234,19 +234,19 @@ typedef struct {
234 234
 } PtsCorrectionContext;
235 235
 
236 236
 /**
237
- * Resets the state of the PtsCorrectionContext.
237
+ * Reset the state of the PtsCorrectionContext.
238 238
  */
239 239
 void init_pts_correction(PtsCorrectionContext *ctx);
240 240
 
241 241
 /**
242
- * Attempts to guess proper monotonic timestamps for decoded video frames
242
+ * Attempt to guess proper monotonic timestamps for decoded video frames
243 243
  * which might have incorrect times. Input timestamps may wrap around, in
244 244
  * which case the output will as well.
245 245
  *
246
- * @param pts The pts field of the decoded AVPacket, as passed through
246
+ * @param pts the pts field of the decoded AVPacket, as passed through
247 247
  * AVCodecContext.reordered_opaque
248
- * @param dts The dts field of the decoded AVPacket
249
- * @return One of the input values. May be AV_NOPTS_VALUE.
248
+ * @param dts the dts field of the decoded AVPacket
249
+ * @return one of the input values, may be AV_NOPTS_VALUE
250 250
  */
251 251
 int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
252 252