[Scummvm-cvs-logs] SF.net SVN: scummvm:[34262] scummvm/trunk/engines/metaengine.h

[fingolfin at users.sourceforge.net]

Revision: 34262
          http://scummvm.svn.sourceforge.net/scummvm/?rev=34262&view=rev
Author:   fingolfin
Date:     2008-09-01 21:06:32 +0000 (Mon, 01 Sep 2008)

Log Message:
-----------
Document each MetaEngineFeature (instead of listing just 'examples'). Wording could be better, feel free to improve it

Modified Paths:
--------------
    scummvm/trunk/engines/metaengine.h

Modified: scummvm/trunk/engines/metaengine.h
===================================================================
--- scummvm/trunk/engines/metaengine.h	2008-09-01 20:41:43 UTC (rev 34261)
+++ scummvm/trunk/engines/metaengine.h	2008-09-01 21:06:32 UTC (rev 34262)
@@ -111,18 +111,25 @@
 	
 	/**
 	 * A feature in this context means an ability of the engine which can be
-	 * either available or not. Examples include:
-	 *  - Supporting the 'Return to launcher' feature (i.e. handles EVENT_RTL)
-	 *  - Listing Save States (i.e. implements the listSaves() method;
-	 *    used for --list-saves support)
-	 *  - Loading from the Launcher (-x)
-	 *  - Deleting Saves from the Launcher (i.e. implements the
-	 *    removeSaveState() method)
+	 * either available or not.
 	 */
 	enum MetaEngineFeature {
+		/** 'Return to launcher' feature (i.e. EVENT_RTL is handled) */
 		kSupportsRTL            = 0,
+
+		/**
+		 * Listing Save States (i.e. implements the listSaves() method;
+		 * used for --list-saves support)
+		 */
 		kSupportsListSaves      = 1,
+		
+		/** Loading from the Launcher / command line (-x) */
 		kSupportsDirectLoad     = 2,
+
+		/**
+		 * Deleting Saves from the Launcher (i.e. implements the
+		 * removeSaveState() method)
+		 */
 		kSupportsDeleteSave     = 3
 	};	
 


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