[Scummvm-cvs-logs] SF.net SVN: scummvm:[53481] scummvm/trunk/engines

[fingolfin at users.sourceforge.net]

Revision: 53481
          http://scummvm.svn.sourceforge.net/scummvm/?rev=53481&view=rev
Author:   fingolfin
Date:     2010-10-15 12:28:56 +0000 (Fri, 15 Oct 2010)

Log Message:
-----------
Add doxygen comment for namespaces of several engines.

This is an empty template which ideally engine maintainers
would update and complete with concrete information...

Modified Paths:
--------------
    scummvm/trunk/engines/hugo/hugo.h
    scummvm/trunk/engines/mohawk/mohawk.h
    scummvm/trunk/engines/sword25/detection.cpp
    scummvm/trunk/engines/sword25/sword25.h
    scummvm/trunk/engines/toon/toon.h

Modified: scummvm/trunk/engines/hugo/hugo.h
===================================================================
--- scummvm/trunk/engines/hugo/hugo.h	2010-10-15 12:19:34 UTC (rev 53480)
+++ scummvm/trunk/engines/hugo/hugo.h	2010-10-15 12:28:56 UTC (rev 53481)
@@ -45,7 +45,16 @@
 class RandomSource;
 }
 
+/**
+ * This is the namespace of the Hugo engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
 namespace Hugo {
+
 enum GameType {
 	kGameTypeNone  = 0,
 	kGameTypeHugo1,

Modified: scummvm/trunk/engines/mohawk/mohawk.h
===================================================================
--- scummvm/trunk/engines/mohawk/mohawk.h	2010-10-15 12:19:34 UTC (rev 53480)
+++ scummvm/trunk/engines/mohawk/mohawk.h	2010-10-15 12:28:56 UTC (rev 53481)
@@ -37,6 +37,14 @@
 	class SeekableReadStream;
 }
 
+/**
+ * This is the namespace of the Mohawk engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
 namespace Mohawk {
 
 enum MohawkGameType {

Modified: scummvm/trunk/engines/sword25/detection.cpp
===================================================================
--- scummvm/trunk/engines/sword25/detection.cpp	2010-10-15 12:19:34 UTC (rev 53480)
+++ scummvm/trunk/engines/sword25/detection.cpp	2010-10-15 12:28:56 UTC (rev 53481)
@@ -68,7 +68,7 @@
 	AD_TABLE_END_MARKER
 };
 
-} // end of namespace Sword25
+} // End of namespace Sword25
 
 static const char *directoryGlobs[] = {
 	"system", // Used by extracted dats

Modified: scummvm/trunk/engines/sword25/sword25.h
===================================================================
--- scummvm/trunk/engines/sword25/sword25.h	2010-10-15 12:19:34 UTC (rev 53480)
+++ scummvm/trunk/engines/sword25/sword25.h	2010-10-15 12:28:56 UTC (rev 53481)
@@ -35,6 +35,14 @@
 
 struct ADGameDescription;
 
+/**
+ * This is the namespace of the Sword25 engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
 namespace Sword25 {
 
 enum {

Modified: scummvm/trunk/engines/toon/toon.h
===================================================================
--- scummvm/trunk/engines/toon/toon.h	2010-10-15 12:19:34 UTC (rev 53480)
+++ scummvm/trunk/engines/toon/toon.h	2010-10-15 12:28:56 UTC (rev 53481)
@@ -46,7 +46,16 @@
 #define TOON_SAVEGAME_VERSION 4
 #define DATAALIGNMENT 4
 
+/**
+ * This is the namespace of the Toon engine.
+ *
+ * Status of this engine: ???
+ *
+ * Supported games:
+ * - ???
+ */
 namespace Toon {
+
 enum ToonGameType {
 	GType_TOON = 1
 };


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.