IMAGES: Document which games use the different image formats

src/images/dds.cpp

@@ -19,7 +19,7 @@
  */
 
 /** @file
- *  DDS (DirectDraw Surface) loading.
+ *  DDS texture (DirectDraw Surface or BioWare's own format) loading).
  */
 
 #include "src/common/scopedptr.h"

src/images/dds.h

@@ -19,7 +19,7 @@
  */
 
 /** @file
- *  DDS (DirectDraw Surface) loading.
+ *  DDS texture (DirectDraw Surface or BioWare's own format) loading).
  */
 
 #ifndef IMAGES_DDS_H
@@ -33,9 +33,13 @@ namespace Common {
 
 namespace Images {
 
-/** DirectDraw Surface.
+/** DDS texture.
  *
- *  Both standard DDS files and BioWare's own version are supported.
+ * There are two different DDS file formats:
+ * - One is the standard DirectDraw Surface format, introduced by Microsoft
+ *   with DirectX 7.0. This format is used by Neverwinter Nights 2,
+ *   The Witcher and the two Dragon Age games.
+ * - The other is BioWare's own texture format, used by Neverwinter Nights.
  */
 class DDS : public Decoder {
 public:

src/images/sbm.h

@@ -33,7 +33,10 @@ namespace Common {
 
 namespace Images {
 
-/** SBM font bitmap data. */
+/** SBM font bitmap data.
+ *
+ *  This format is used for fonts in Jade Empire.
+ */
 class SBM : public Decoder {
 public:
 	SBM(Common::SeekableReadStream &sbm);

src/images/tga.h

@@ -58,7 +58,11 @@ namespace Common {
 
 namespace Images {
 
-/** TarGa image. */
+/** TarGa image.
+ *
+ *  This format is used in the two Neverwinter Nights games, the two
+ *  Knights of the Old Republic games, Jade Empire and Sonic.
+ */
 class TGA : public Decoder {
 public:
 	TGA(Common::SeekableReadStream &tga);

src/images/tpc.h

@@ -35,7 +35,12 @@ namespace Common {
 
 namespace Images {
 
-/** BioWare's own texture format, TPC. */
+/** BioWare's own texture format, TPC.
+ *
+ *  This format is used by the two Knights of the Old Republic games.
+ *  In the Xbox versions, these files have a .txb extension, but
+ *  are still this format (not the TXB format used in Jade Empire).
+ */
 class TPC : public Decoder {
 public:
 	TPC(Common::SeekableReadStream &tpc);

src/images/txb.h

@@ -35,7 +35,14 @@ namespace Common {
 
 namespace Images {
 
-/** Another one of BioWare's own texture formats, TXB. */
+/** Another one of BioWare's own texture formats, TXB.
+ *
+ *  This format is used by Jade Empire.
+ *
+ *  Even though the Xbox versions of the Knights of the Old Republic games
+ *  features textures with a .txb extension, these are actually in the TPC
+ *  format, not this TXB format.
+ */
 class TXB : public Decoder {
 public:
 	TXB(Common::SeekableReadStream &txb);