Browse code

cosmetics: typo/grammar fixes in doxygen and other comments

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

Diego Biurrun authored on 2009/02/09 08:34:58
Showing 1 changed files
... ...
@@ -1,5 +1,5 @@
1 1
 /*
2
- * Audio Interleaving prototypes and declarations
2
+ * audio interleaving prototypes and declarations
3 3
  *
4 4
  * Copyright (c) 2009 Baptiste Coudurier <baptiste dot coudurier at gmail dot com>
5 5
  *
... ...
@@ -28,10 +28,10 @@
28 28
 
29 29
 typedef struct {
30 30
     AVFifoBuffer fifo;
31
-    unsigned fifo_size;           ///< current fifo size allocated
31
+    unsigned fifo_size;           ///< size of currently allocated FIFO
32 32
     uint64_t dts;                 ///< current dts
33 33
     int sample_size;              ///< size of one sample all channels included
34
-    const int *samples_per_frame; ///< must be 0 terminated
34
+    const int *samples_per_frame; ///< must be 0-terminated
35 35
     const int *samples;           ///< current samples per frame, pointer to samples_per_frame
36 36
     AVRational time_base;         ///< time base of output audio packets
37 37
 } AudioInterleaveContext;
... ...
@@ -41,9 +41,9 @@ void ff_audio_interleave_close(AVFormatContext *s);
41 41
 
42 42
 int ff_interleave_compare_dts(AVFormatContext *s, AVPacket *next, AVPacket *pkt);
43 43
 /**
44
- * Rechunk audio pcm packets per AudioInterleaveContext->samples_per_frame
44
+ * Rechunk audio PCM packets per AudioInterleaveContext->samples_per_frame
45 45
  * and interleave them correctly.
46
- * AVStream->priv_data first element must be AudioInterleaveContext
46
+ * The first element of AVStream->priv_data must be AudioInterleaveContext
47 47
  * when using this function.
48 48
  *
49 49
  * @param get_packet function will output a packet when streams are correctly interleaved.
... ...
@@ -53,4 +53,4 @@ int ff_audio_interleave(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int fl
53 53
                         int (*get_packet)(AVFormatContext *, AVPacket *, AVPacket *, int),
54 54
                         int (*compare_ts)(AVFormatContext *, AVPacket *, AVPacket *));
55 55
 
56
-#endif // AVFORMAT_AUDIOINTERLEAVE_H
56
+#endif /* AVFORMAT_AUDIOINTERLEAVE_H */