ENGINES: Enhance namespace comments a bit

svn-id: r53484
2024-12-05 00:36:57 +00:00 · 2010-10-15 12:48:19 +00:00 · 2010-10-15 12:48:19 +00:00 · 4ccce19876
commit 4ccce19876
parent 42f2a13155
28 changed files with 79 additions and 50 deletions
--- 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 {

--- 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 {

--- 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
--- 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 {
--- 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 {

--- 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 {

--- 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 {

--- 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
--- 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 {

--- 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)
--- 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 {

--- 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
 */
--- 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 {

--- 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 {

--- 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 {

--- 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 {

--- 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
--- 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 {

--- 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 {

--- 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 {

--- 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 {

--- 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 {

--- 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 {

--- 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 {
--- 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 ...!?
 */
--- 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 {

--- 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 {

--- 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 {