[FFmpeg-soc] [soc]: r5144 - spdif/spdif.c

[bwolowiec]

Author: bwolowiec
Date: Sat Aug 15 22:14:52 2009
New Revision: 5144

Log:
Improve documentation

Modified:
   spdif/spdif.c

Modified: spdif/spdif.c
==============================================================================
--- spdif/spdif.c	Sat Aug 15 22:13:21 2009	(r5143)
+++ spdif/spdif.c	Sat Aug 15 22:14:52 2009	(r5144)
@@ -51,12 +51,13 @@ enum IEC958DataType {
 };
 
 typedef struct IEC958Context {
-    enum IEC958DataType data_type;              ///< Burst info
-    int pkt_size;               ///< Length code (number of bits or bytes - according to data_type)
-    int pkt_offset;             ///< Repetition period of a data burst in bytes
+    enum IEC958DataType data_type;  ///< Burst info - reference to type of payload of the data-burst
+    int pkt_size;                   ///< Length code (number of bits or bytes - according to data_type)
+    int pkt_offset;                 ///< Repetition period of data burst in bytes
+    uint8_t *buffer;                ///< Allocated buffer, used for swap bytes
+    int buffer_size;                ///< Size of allocated buffer
+    /// Function, which generates codec dependent header information
     int (*header_info) (AVFormatContext *s, AVPacket *pkt);
-    uint8_t *buffer;
-    int buffer_size;
 } IEC958Context;
 
 //TODO move to DSP