From 4ccce198761e9e7da5ec495345515f7ddf922743 Mon Sep 17 00:00:00 2001
From: Max Horn
Date: Fri, 15 Oct 2010 12:48:19 +0000
Subject: ENGINES: Enhance namespace comments a bit

svn-id: r53484
---
 engines/agi/agi.h                   |  8 ++++++--
 engines/agos/agos.h                 |  9 +++++++--
 engines/cine/cine.h                 |  2 +-
 engines/cruise/cruise.h             |  2 +-
 engines/draci/draci.h               |  6 +++---
 engines/drascula/drascula.h         |  4 ++--
 engines/gob/gob.h                   | 10 ++++++++--
 engines/groovie/groovie.h           |  2 +-
 engines/hugo/hugo.h                 |  6 ++++--
 engines/kyra/kyra_v1.h              |  2 +-
 engines/lure/lure.h                 |  6 +++---
 engines/m4/m4.h                     |  2 +-
 engines/made/made.h                 |  7 +++++--
 engines/mohawk/mohawk.h             |  5 +++--
 engines/parallaction/parallaction.h |  5 +++--
 engines/queen/queen.h               |  4 ++--
 engines/saga/saga.h                 |  2 +-
 engines/sci/sci.h                   |  7 +++++--
 engines/scumm/scumm.h               | 10 +++++++---
 engines/sky/sky.h                   |  4 ++--
 engines/sword1/sword1.h             |  4 ++--
 engines/sword2/sword2.h             |  4 ++--
 engines/sword25/sword25.h           |  4 ++--
 engines/teenagent/teenagent.h       |  2 +-
 engines/tinsel/tinsel.h             |  2 +-
 engines/toon/toon.h                 |  4 ++--
 engines/touche/touche.h             |  4 ++--
 engines/tucker/tucker.h             |  2 +-
 28 files changed, 79 insertions(+), 50 deletions(-)

(limited to 'engines')

diff --git a/engines/agi/agi.h b/engines/agi/agi.h
index e991345040..bc9a6810a2 100644
--- a/engines/agi/agi.h
+++ b/engines/agi/agi.h
@@ -52,8 +52,12 @@ namespace Common { class RandomSource; }
  *
  * Status of this engine: ???
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Early Sierra adventure games
+ * - many fan made games
+ * - Mickey's Space Adventure (Pre-AGI)
+ * - Winnie the Pooh in the Hundred Acre Wood (Pre-AGI)
+ * - Troll's Tale (Pre-AGI)
  */
 namespace Agi {
 
diff --git a/engines/agos/agos.h b/engines/agos/agos.h
index b12bf09d62..5ebfc7b87f 100644
--- a/engines/agos/agos.h
+++ b/engines/agos/agos.h
@@ -47,8 +47,13 @@
  *
  * Status of this engine: ???
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Elvira: Mistress of the Dark
+ * - Elvira 2: The Jaws of Cerberus
+ * - The Feeble Files
+ * - Simon the Sorcerer
+ * - Simon the Sorcerer 2
+ * - Simon the Sorcerer Puzzle Pack
  */
 namespace AGOS {
 
diff --git a/engines/cine/cine.h b/engines/cine/cine.h
index 114d98d442..cab6b92a5d 100644
--- a/engines/cine/cine.h
+++ b/engines/cine/cine.h
@@ -71,7 +71,7 @@
  * yet been finished. The game is not completable.
  *
  *
- * Supported games:
+ * Games using this engine:
  *
  * Cinematique evo.1
  * - Future Wars
diff --git a/engines/cruise/cruise.h b/engines/cruise/cruise.h
index 94f5c68ca0..ad3bb20ca1 100644
--- a/engines/cruise/cruise.h
+++ b/engines/cruise/cruise.h
@@ -42,7 +42,7 @@
  *
  * Status of this engine: Game is completable, engine needs objectifying
  *
- * Supported games:
+ * Games using this engine:
  * - Cruise for a Corpse
  */
 namespace Cruise {
diff --git a/engines/draci/draci.h b/engines/draci/draci.h
index 605e8cc238..597269f025 100644
--- a/engines/draci/draci.h
+++ b/engines/draci/draci.h
@@ -37,10 +37,10 @@ class OSystem;
 /**
  * This is the namespace of the Draci engine.
  *
- * Status of this engine: ???
+ * Status of this engine: Complete
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Dragon History
  */
 namespace Draci {
 
diff --git a/engines/drascula/drascula.h b/engines/drascula/drascula.h
index 0a8b7c8c9b..535a9005d2 100644
--- a/engines/drascula/drascula.h
+++ b/engines/drascula/drascula.h
@@ -47,8 +47,8 @@
  *
  * Status of this engine: ???
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Drascula: The Vampire Strikes Back
  */
 namespace Drascula {
 
diff --git a/engines/gob/gob.h b/engines/gob/gob.h
index c5d406af95..fe69e27c01 100644
--- a/engines/gob/gob.h
+++ b/engines/gob/gob.h
@@ -43,8 +43,14 @@ namespace GUI {
  *
  * Status of this engine: ???
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Gobliiins
+ * - Gobliins 2
+ * - Goblins 3
+ * - Ween: The Prophecy
+ * - Bargon Attack
+ * - Lost in Time
+ * - The Bizarre Adventures of Woodruff and the Schnibble
  */
 namespace Gob {
 
diff --git a/engines/groovie/groovie.h b/engines/groovie/groovie.h
index 8ae5f4157f..f8fad8d91f 100644
--- a/engines/groovie/groovie.h
+++ b/engines/groovie/groovie.h
@@ -44,7 +44,7 @@ namespace Common {
  * now fully completable.  All remaining Groovie games use V2 of the engine,
  * which is under slow development.
  *
- * Supported games:
+ * Games using this engine:
  * - The 7th Guest (completable)
  * - The 11th Hour
  * - Clandestiny
diff --git a/engines/hugo/hugo.h b/engines/hugo/hugo.h
index b9a3047b45..cf01eb83ca 100644
--- a/engines/hugo/hugo.h
+++ b/engines/hugo/hugo.h
@@ -50,8 +50,10 @@ class RandomSource;
  *
  * Status of this engine: ???
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Hugo's House of Horror
+ * - Whodunit?
+ * - Jungle of Doom
  */
 namespace Hugo {
 
diff --git a/engines/kyra/kyra_v1.h b/engines/kyra/kyra_v1.h
index d077d3a3b0..b4b1e720c9 100644
--- a/engines/kyra/kyra_v1.h
+++ b/engines/kyra/kyra_v1.h
@@ -93,7 +93,7 @@ class KyraMetaEngine;
  * is pretty minor priority though, since the benefit would be mostly nicer code). The biggest
  * task left is the kyra.dat handling, which is currently being revised by LordHoto.
  *
- * Supported games:
+ * Games using this engine:
  * - The Legend of Kyrandia (fully supported, except for Macintosh port, which lacks sound)
  * - (The) Hand of Fate (fully supported)
  * - Malcolm's Revenge (fully supported)
diff --git a/engines/lure/lure.h b/engines/lure/lure.h
index 15336a3507..297fb20f59 100644
--- a/engines/lure/lure.h
+++ b/engines/lure/lure.h
@@ -46,10 +46,10 @@
 /**
  * This is the namespace of the Lure engine.
  *
- * Status of this engine: ???
+ * Status of this engine: Complete
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Lure of the Temptress
  */
 namespace Lure {
 
diff --git a/engines/m4/m4.h b/engines/m4/m4.h
index b68f7248af..7193bdfba8 100644
--- a/engines/m4/m4.h
+++ b/engines/m4/m4.h
@@ -70,7 +70,7 @@
  * functionality has been implemented. No further work has been done on this for some time, so progress
  * on this part of the engine can be considered frozen.
  *
- * Games this engine will support:
+ * Games using this engine:
  * MADS Games: Dragonsphere, Return of the Phantom, Rex Nebular and the Cosmic Gender Bender
  * M4 Games: Orion Burger, The Riddle of Master Lu
  */
diff --git a/engines/made/made.h b/engines/made/made.h
index 08f9add33d..ed391562c3 100644
--- a/engines/made/made.h
+++ b/engines/made/made.h
@@ -53,8 +53,11 @@
  *
  * Status of this engine: ???
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Return to Zork
+ * - Leather Goddesses of Phobos 2
+ * - The Manhole
+ * - Rodney's Funscreen
  */
 namespace Made {
 
diff --git a/engines/mohawk/mohawk.h b/engines/mohawk/mohawk.h
index 4b6efb3301..7bd76193fc 100644
--- a/engines/mohawk/mohawk.h
+++ b/engines/mohawk/mohawk.h
@@ -42,8 +42,9 @@ namespace Common {
  *
  * Status of this engine: ???
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Myst
+ * - Riven: The Sequel to Myst
  */
 namespace Mohawk {
 
diff --git a/engines/parallaction/parallaction.h b/engines/parallaction/parallaction.h
index 7bbdf79f1c..ded1b3bda4 100644
--- a/engines/parallaction/parallaction.h
+++ b/engines/parallaction/parallaction.h
@@ -48,8 +48,9 @@
  *
  * Status of this engine: ???
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Nippon Safes Inc. (complete)
+ * - The Big Red Adventure (work in progress)
  */
 namespace Parallaction {
 
diff --git a/engines/queen/queen.h b/engines/queen/queen.h
index 5a8f1357f4..93d705b182 100644
--- a/engines/queen/queen.h
+++ b/engines/queen/queen.h
@@ -56,8 +56,8 @@ FORCEINLINE int16 READ_BE_INT16(const void *ptr) {
  *
  * Status of this engine: ???
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Flight of the Amazon Queen
  */
 namespace Queen {
 
diff --git a/engines/saga/saga.h b/engines/saga/saga.h
index 102d1e5c82..34937c5131 100644
--- a/engines/saga/saga.h
+++ b/engines/saga/saga.h
@@ -49,7 +49,7 @@ struct ADGameFileDescription;
  * SAGA2 status: in early stages of development, no recent activity. Contact sev
  *  if you want to work on it, since we have some original source codes.
  *
- * Supported games:
+ * Games using this engine:
  *
  * SAGA:
  * - Inherit the Earth
diff --git a/engines/sci/sci.h b/engines/sci/sci.h
index 008c00f726..8ecdadb8ff 100644
--- a/engines/sci/sci.h
+++ b/engines/sci/sci.h
@@ -39,8 +39,11 @@ struct ADGameDescription;
  *
  * Status of this engine: ???
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Newer Sierra adventure games (based on FreeSCI) 
+ *
+ * @todo give a concrete list of supported games. Could also
+ * list future games, with status for each.
  */
 namespace Sci {
 
diff --git a/engines/scumm/scumm.h b/engines/scumm/scumm.h
index aef5cfbec7..3de7d5257c 100644
--- a/engines/scumm/scumm.h
+++ b/engines/scumm/scumm.h
@@ -66,10 +66,14 @@ namespace Common {
 /**
  * This is the namespace of the SCUMM engine.
  *
- * Status of this engine: ???
+ * Status of this engine:
+ * Complete support for all SCUMM based LucasArts adventures.
+ * Complete support for many Humongous Entertainment games,
+ * but for some of the newer ones, this is still work in progress.
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Classic 2D LucasArts adventures
+ * - numerous Humongous Entertainment games
  */
 namespace Scumm {
 
diff --git a/engines/sky/sky.h b/engines/sky/sky.h
index 7eff8c662a..58c9d1de11 100644
--- a/engines/sky/sky.h
+++ b/engines/sky/sky.h
@@ -35,8 +35,8 @@
  *
  * Status of this engine: ???
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Beneath a Steel Sky
  */
 namespace Sky {
 
diff --git a/engines/sword1/sword1.h b/engines/sword1/sword1.h
index a0497847d5..5b1deaa3ed 100644
--- a/engines/sword1/sword1.h
+++ b/engines/sword1/sword1.h
@@ -36,8 +36,8 @@
  *
  * Status of this engine: ???
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Broken Sword: The Shadow of the Templars
  */
 namespace Sword1 {
 
diff --git a/engines/sword2/sword2.h b/engines/sword2/sword2.h
index 201ce5e836..4fb856804b 100644
--- a/engines/sword2/sword2.h
+++ b/engines/sword2/sword2.h
@@ -53,8 +53,8 @@ class OSystem;
  *
  * Status of this engine: ???
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Broken Sword II: The Smoking Mirror
  */
 namespace Sword2 {
 
diff --git a/engines/sword25/sword25.h b/engines/sword25/sword25.h
index ff97a18f03..cfbc26061a 100644
--- a/engines/sword25/sword25.h
+++ b/engines/sword25/sword25.h
@@ -40,8 +40,8 @@ struct ADGameDescription;
  *
  * Status of this engine: ???
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Broken Sword 2.5
  */
 namespace Sword25 {
 
diff --git a/engines/teenagent/teenagent.h b/engines/teenagent/teenagent.h
index dc195c0f4e..069e6e40d0 100644
--- a/engines/teenagent/teenagent.h
+++ b/engines/teenagent/teenagent.h
@@ -40,7 +40,7 @@ struct ADGameDescription;
  *
  * Status of this engine: Complete
  *
- * Supported games:
+ * Games using this engine:
  * - Teen Agent
  */
 namespace TeenAgent {
diff --git a/engines/tinsel/tinsel.h b/engines/tinsel/tinsel.h
index ed70979349..04b8825ace 100644
--- a/engines/tinsel/tinsel.h
+++ b/engines/tinsel/tinsel.h
@@ -48,7 +48,7 @@
  *
  * Status of this engine: Complete
  *
- * Supported games:
+ * Games using this engine:
  * - Discworld
  * - Discworld 2: Missing Presumed ...!?
  */
diff --git a/engines/toon/toon.h b/engines/toon/toon.h
index c1b036127e..8f6489a4fd 100644
--- a/engines/toon/toon.h
+++ b/engines/toon/toon.h
@@ -51,8 +51,8 @@
  *
  * Status of this engine: ???
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Toonstruck
  */
 namespace Toon {
 
diff --git a/engines/touche/touche.h b/engines/touche/touche.h
index 33ca81ed4f..0081cadbae 100644
--- a/engines/touche/touche.h
+++ b/engines/touche/touche.h
@@ -42,8 +42,8 @@
  *
  * Status of this engine: ???
  *
- * Supported games:
- * - ???
+ * Games using this engine:
+ * - Touche: The Adventures of the Fifth Musketeer
  */
 namespace Touche {
 
diff --git a/engines/tucker/tucker.h b/engines/tucker/tucker.h
index 86f5843e77..de7042386b 100644
--- a/engines/tucker/tucker.h
+++ b/engines/tucker/tucker.h
@@ -44,7 +44,7 @@
  *
  * Status of this engine: Complete
  *
- * Supported games:
+ * Games using this engine:
  * - Bud Tucker in Double Trouble
  */
 namespace Tucker {
-- 
cgit v1.2.3