[Scummvm-cvs-logs] SF.net SVN: scummvm:[46128] scummvm/trunk/engines
fingolfin at users.sourceforge.net
fingolfin at users.sourceforge.net
Tue Nov 24 23:10:14 CET 2009
Revision: 46128
http://scummvm.svn.sourceforge.net/scummvm/?rev=46128&view=rev
Author: fingolfin
Date: 2009-11-24 22:10:14 +0000 (Tue, 24 Nov 2009)
Log Message:
-----------
Added Doxygen comments for the various engine namespaces (currently mostly without details; help filling these out is welcome)
Modified Paths:
--------------
scummvm/trunk/engines/agi/agi.h
scummvm/trunk/engines/agos/agos.h
scummvm/trunk/engines/cine/cine.h
scummvm/trunk/engines/cruise/cruise.h
scummvm/trunk/engines/draci/draci.h
scummvm/trunk/engines/drascula/drascula.h
scummvm/trunk/engines/gob/gob.h
scummvm/trunk/engines/groovie/groovie.h
scummvm/trunk/engines/kyra/kyra_v1.h
scummvm/trunk/engines/lure/lure.h
scummvm/trunk/engines/m4/m4.h
scummvm/trunk/engines/made/made.h
scummvm/trunk/engines/parallaction/parallaction.h
scummvm/trunk/engines/queen/queen.h
scummvm/trunk/engines/saga/saga.h
scummvm/trunk/engines/sci/sci.h
scummvm/trunk/engines/scumm/scumm.h
scummvm/trunk/engines/sky/sky.h
scummvm/trunk/engines/sword1/sword1.h
scummvm/trunk/engines/sword2/sword2.h
scummvm/trunk/engines/teenagent/teenagent.h
scummvm/trunk/engines/tinsel/tinsel.h
scummvm/trunk/engines/touche/touche.h
scummvm/trunk/engines/tucker/tucker.h
Modified: scummvm/trunk/engines/agi/agi.h
===================================================================
--- scummvm/trunk/engines/agi/agi.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/agi/agi.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -38,6 +38,14 @@
#include "engines/engine.h"
+/**
+ * This is the namespace of the AGI engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Agi {
typedef signed int Err;
Modified: scummvm/trunk/engines/agos/agos.h
===================================================================
--- scummvm/trunk/engines/agos/agos.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/agos/agos.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -41,6 +41,14 @@
#include "agos/sound.h"
#include "agos/vga.h"
+/**
+ * This is the namespace of the AGOS engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace AGOS {
uint fileReadItemID(Common::SeekableReadStream *in);
Modified: scummvm/trunk/engines/cine/cine.h
===================================================================
--- scummvm/trunk/engines/cine/cine.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/cine/cine.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -49,6 +49,14 @@
//#define DUMP_SCRIPTS
+/**
+ * This is the namespace of the Cine engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Cine {
enum CineGameType {
Modified: scummvm/trunk/engines/cruise/cruise.h
===================================================================
--- scummvm/trunk/engines/cruise/cruise.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/cruise/cruise.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -36,6 +36,14 @@
#include "cruise/debugger.h"
#include "cruise/sound.h"
+/**
+ * This is the namespace of the Cruise engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Cruise {
enum CruiseGameType {
Modified: scummvm/trunk/engines/draci/draci.h
===================================================================
--- scummvm/trunk/engines/draci/draci.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/draci/draci.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -43,6 +43,14 @@
struct ADGameDescription;
+/**
+ * This is the namespace of the Draci engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Draci {
class DraciEngine : public Engine {
Modified: scummvm/trunk/engines/drascula/drascula.h
===================================================================
--- scummvm/trunk/engines/drascula/drascula.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/drascula/drascula.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -41,6 +41,14 @@
#include "engines/engine.h"
+/**
+ * This is the namespace of the Drascula engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Drascula {
#define DRASCULA_DAT_VER 4
Modified: scummvm/trunk/engines/gob/gob.h
===================================================================
--- scummvm/trunk/engines/gob/gob.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/gob/gob.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -37,6 +37,14 @@
class StaticTextWidget;
}
+/**
+ * This is the namespace of the Gob engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Gob {
class Game;
Modified: scummvm/trunk/engines/groovie/groovie.h
===================================================================
--- scummvm/trunk/engines/groovie/groovie.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/groovie/groovie.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -36,6 +36,14 @@
#include "groovie/resource.h"
#include "groovie/script.h"
+/**
+ * This is the namespace of the Groovie engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Groovie {
class MusicPlayer;
Modified: scummvm/trunk/engines/kyra/kyra_v1.h
===================================================================
--- scummvm/trunk/engines/kyra/kyra_v1.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/kyra/kyra_v1.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -43,6 +43,14 @@
class KyraMetaEngine;
+/**
+ * This is the namespace of the Kyra engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Kyra {
struct GameFlags {
Modified: scummvm/trunk/engines/lure/lure.h
===================================================================
--- scummvm/trunk/engines/lure/lure.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/lure/lure.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -42,6 +42,14 @@
#include "lure/room.h"
#include "lure/fights.h"
+/**
+ * This is the namespace of the Lure engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Lure {
#define RandomNumberGen LureEngine::getReference().rnd()
Modified: scummvm/trunk/engines/m4/m4.h
===================================================================
--- scummvm/trunk/engines/m4/m4.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/m4/m4.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -48,6 +48,14 @@
//#define DUMP_SCRIPTS
+/**
+ * This is the namespace of the M4 engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace M4 {
class MidiPlayer;
Modified: scummvm/trunk/engines/made/made.h
===================================================================
--- scummvm/trunk/engines/made/made.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/made/made.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -47,6 +47,14 @@
#include "made/sound.h"
+/**
+ * This is the namespace of the Made engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Made {
enum MadeGameID {
Modified: scummvm/trunk/engines/parallaction/parallaction.h
===================================================================
--- scummvm/trunk/engines/parallaction/parallaction.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/parallaction/parallaction.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -42,6 +42,14 @@
#define PATH_LEN 200
+/**
+ * This is the namespace of the Parallaction engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Parallaction {
enum {
Modified: scummvm/trunk/engines/queen/queen.h
===================================================================
--- scummvm/trunk/engines/queen/queen.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/queen/queen.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -50,6 +50,14 @@
#endif
+/**
+ * This is the namespace of the Queen engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Queen {
struct GameStateHeader {
Modified: scummvm/trunk/engines/saga/saga.h
===================================================================
--- scummvm/trunk/engines/saga/saga.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/saga/saga.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -35,6 +35,14 @@
struct ADGameFileDescription;
+/**
+ * This is the namespace of the SAGA engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Saga {
class SndRes;
Modified: scummvm/trunk/engines/sci/sci.h
===================================================================
--- scummvm/trunk/engines/sci/sci.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/sci/sci.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -31,6 +31,14 @@
struct ADGameDescription;
+/**
+ * This is the namespace of the SCI engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Sci {
#define INCLUDE_OLDGFX
Modified: scummvm/trunk/engines/scumm/scumm.h
===================================================================
--- scummvm/trunk/engines/scumm/scumm.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/scumm/scumm.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -51,6 +51,14 @@
class WriteStream;
}
+/**
+ * This is the namespace of the SCUMM engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Scumm {
class Actor;
Modified: scummvm/trunk/engines/sky/sky.h
===================================================================
--- scummvm/trunk/engines/sky/sky.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/sky/sky.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -30,6 +30,14 @@
#include "common/events.h"
#include "engines/engine.h"
+/**
+ * This is the namespace of the Sky engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Sky {
struct SystemVars {
Modified: scummvm/trunk/engines/sword1/sword1.h
===================================================================
--- scummvm/trunk/engines/sword1/sword1.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/sword1/sword1.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -31,6 +31,14 @@
#include "common/util.h"
#include "sword1/sworddefs.h"
+/**
+ * This is the namespace of the Sword1 engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Sword1 {
enum {
Modified: scummvm/trunk/engines/sword2/sword2.h
===================================================================
--- scummvm/trunk/engines/sword2/sword2.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/sword2/sword2.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -47,6 +47,14 @@
class OSystem;
+/**
+ * This is the namespace of the Sword2 engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Sword2 {
enum {
Modified: scummvm/trunk/engines/teenagent/teenagent.h
===================================================================
--- scummvm/trunk/engines/teenagent/teenagent.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/teenagent/teenagent.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -34,6 +34,14 @@
struct ADGameDescription;
+/**
+ * This is the namespace of the TeenAgent engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace TeenAgent {
struct Object;
Modified: scummvm/trunk/engines/tinsel/tinsel.h
===================================================================
--- scummvm/trunk/engines/tinsel/tinsel.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/tinsel/tinsel.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -42,6 +42,15 @@
#include "tinsel/sound.h"
#include "tinsel/dw.h"
+/**
+ * This is the namespace of the Tinsel engine.
+ *
+ * Status of this engine: Complete
+ *
+ * Supported games:
+ * - Discworld
+ * - Discworld 2: Missing Presumed ...!?
+ */
namespace Tinsel {
class BMVPlayer;
Modified: scummvm/trunk/engines/touche/touche.h
===================================================================
--- scummvm/trunk/engines/touche/touche.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/touche/touche.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -36,6 +36,14 @@
#include "engines/engine.h"
+/**
+ * This is the namespace of the Touche engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
namespace Touche {
struct Area {
Modified: scummvm/trunk/engines/tucker/tucker.h
===================================================================
--- scummvm/trunk/engines/tucker/tucker.h 2009-11-24 22:08:34 UTC (rev 46127)
+++ scummvm/trunk/engines/tucker/tucker.h 2009-11-24 22:10:14 UTC (rev 46128)
@@ -38,6 +38,14 @@
#include "engines/engine.h"
+/**
+ * This is the namespace of the Tucker engine.
+ *
+ * Status of this engine: Complete
+ *
+ * Supported games:
+ * - Bud Tucker in Double Trouble
+ */
namespace Tucker {
struct Action {
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the Scummvm-git-logs
mailing list