diff options
author | Matthew Hoops | 2011-07-18 10:21:20 -0400 |
---|---|---|
committer | Matthew Hoops | 2011-07-18 10:21:20 -0400 |
commit | e6171fbb7415076926aa8d9123b39ab530508a8f (patch) | |
tree | 7385207f5288887fb43dfafcf706c2d4a09b43e7 | |
parent | c4d3a8601021e438fdf877483209fc7488101e4a (diff) | |
download | scummvm-rg350-e6171fbb7415076926aa8d9123b39ab530508a8f.tar.gz scummvm-rg350-e6171fbb7415076926aa8d9123b39ab530508a8f.tar.bz2 scummvm-rg350-e6171fbb7415076926aa8d9123b39ab530508a8f.zip |
COMMON: Update class documentation to say they're now used by SCUMM
-rw-r--r-- | common/bitstream.h | 7 | ||||
-rw-r--r-- | common/dct.h | 7 | ||||
-rw-r--r-- | common/fft.h | 7 | ||||
-rw-r--r-- | common/huffman.h | 7 | ||||
-rw-r--r-- | common/rdft.h | 8 |
5 files changed, 31 insertions, 5 deletions
diff --git a/common/bitstream.h b/common/bitstream.h index 99aec252a3..d9610b269a 100644 --- a/common/bitstream.h +++ b/common/bitstream.h @@ -31,7 +31,12 @@ namespace Common { class SeekableReadStream; -/** A bit stream. */ +/** + * A bit stream. + * + * Used in engines: + * - scumm + */ class BitStream { public: BitStream(); diff --git a/common/dct.h b/common/dct.h index a0d625d55d..2c8c5129b8 100644 --- a/common/dct.h +++ b/common/dct.h @@ -35,7 +35,12 @@ namespace Common { -/** (Inverse) Discrete Cosine Transforms. */ +/** + * (Inverse) Discrete Cosine Transforms. + * + * Used in engines: + * - scumm + */ class DCT { public: enum TransformType { diff --git a/common/fft.h b/common/fft.h index 17d1ef0055..e77c53c2a7 100644 --- a/common/fft.h +++ b/common/fft.h @@ -34,7 +34,12 @@ namespace Common { -/** (Inverse) Fast Fourier Transform. */ +/** + * (Inverse) Fast Fourier Transform. + * + * Used in engines: + * - scumm + */ class FFT { public: FFT(int bits, int inverse); diff --git a/common/huffman.h b/common/huffman.h index 9c88a37541..7d0bdcabf4 100644 --- a/common/huffman.h +++ b/common/huffman.h @@ -33,7 +33,12 @@ namespace Common { class BitStream; -/** Decode a Huffman'd bitstream. */ +/** + * Huffman bitstream decoding + * + * Used in engines: + * - scumm + */ class Huffman { public: /** Construct a Huffman decoder. diff --git a/common/rdft.h b/common/rdft.h index 33fcdd2b3b..68be0f4dac 100644 --- a/common/rdft.h +++ b/common/rdft.h @@ -33,7 +33,13 @@ namespace Common { -/** (Inverse) Real Discrete Fourier Transform. */ +/** + * (Inverse) Real Discrete Fourier Transform. + * + * Used in engines: + * - scumm + */ + class RDFT { public: enum TransformType { |