# HG changeset patch
# User jbr
# Date 1233367843 0
# Node ID f284b60e2bc5ca7801b5642a584cfbae0eb92066
# Parent  eaae57fe72b24f2c848e289481e31b934c0823cf
cosmetics: add some documentation to FLACContext

diff -r eaae57fe72b2 -r f284b60e2bc5 flacdec.c
--- a/flacdec.c	Sat Jan 31 01:50:18 2009 +0000
+++ b/flacdec.c	Sat Jan 31 02:10:43 2009 +0000
@@ -58,16 +58,16 @@
 typedef struct FLACContext {
     FLACSTREAMINFO
 
-    AVCodecContext *avctx;
-    GetBitContext gb;
+    AVCodecContext *avctx;                  ///< parent AVCodecContext
+    GetBitContext gb;                       ///< GetBitContext initialized to start at the current frame
 
-    int blocksize/*, last_blocksize*/;
-    int curr_bps;
+    int blocksize;                          ///< number of samples in the current frame
+    int curr_bps;                           ///< bps for current subframe, adjusted for channel correlation and wasted bits
     int sample_shift;   /* shift required to make output samples 16-bit or 32-bit */
     int is32;           /* flag to indicate if output should be 32-bit instead of 16-bit */
-    enum decorrelation_type decorrelation;
+    enum decorrelation_type decorrelation;  ///< channel decorrelation type in the current frame
 
-    int32_t *decoded[MAX_CHANNELS];
+    int32_t *decoded[MAX_CHANNELS];         ///< decoded samples
     uint8_t *bitstream;
     unsigned int bitstream_size;
     unsigned int bitstream_index;