From 4567cfc61c3981e4ed9da89ff07bfac7424c5fe3 Mon Sep 17 00:00:00 2001
From: Max Horn
Date: Mon, 1 Sep 2008 21:06:32 +0000
Subject: Document each MetaEngineFeature (instead of listing just 'examples').
 Wording could be better, feel free to improve it

svn-id: r34262
---
 engines/metaengine.h | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

(limited to 'engines')

diff --git a/engines/metaengine.h b/engines/metaengine.h
index 1e71a5f179..cde887eb14 100644
--- a/engines/metaengine.h
+++ b/engines/metaengine.h
@@ -111,18 +111,25 @@ public:
 	
 	/**
 	 * 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
 	};	
 
-- 
cgit v1.2.3