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

[lordhoto at users.sourceforge.net]

Revision: 34964
          http://scummvm.svn.sourceforge.net/scummvm/?rev=34964&view=rev
Author:   lordhoto
Date:     2008-11-09 17:43:39 +0000 (Sun, 09 Nov 2008)

Log Message:
-----------
Updated documentation.

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

Modified: scummvm/trunk/engines/metaengine.h
===================================================================
--- scummvm/trunk/engines/metaengine.h	2008-11-09 16:13:34 UTC (rev 34963)
+++ scummvm/trunk/engines/metaengine.h	2008-11-09 17:43:39 UTC (rev 34964)
@@ -99,6 +99,20 @@
 	}
 
 	/**
+	 * Return the maximum save slot that the engine supports.
+	 *
+	 * @note MetaEngines must indicate that this function has been implemented
+	 *       via the kSupportsListSaves feature flag.
+	 *
+	 * The default implementation limits the save slots to zero (0).
+	 *
+	 * @return			maximum save slot number supported
+	 */
+	virtual int getMaximumSaveSlot() const {
+		return 0;
+	}
+
+	/**
 	 * Remove the specified save state. 
 	 *
 	 * For most engines this just amounts to calling _saveFileMan->removeSaveFile().  
@@ -125,13 +139,6 @@
 		return SaveStateDescriptor();
 	}
 
-	/**
-	 * Gets the maximum save slot that the engine supports
-	 */
-	virtual int getMaximumSaveSlot() const {
-		return 0;
-	}
-
 	/** @name MetaEngineFeature flags */
 	//@{
 	
@@ -142,7 +149,7 @@
 	enum MetaEngineFeature {
 		/**
 		 * Listing all Save States for a given target is supported, i.e.,
-		 * the listSaves() method is implemented.
+		 * the listSaves() and getMaximumSaveSlot methods are implemented.
 		 * Used for --list-saves support, as well as the GMM load dialog.
 		 */
 		kSupportsListSaves,


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