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

[lordhoto at users.sourceforge.net]

Revision: 34887
          http://scummvm.svn.sourceforge.net/scummvm/?rev=34887&view=rev
Author:   lordhoto
Date:     2008-11-03 20:00:36 +0000 (Mon, 03 Nov 2008)

Log Message:
-----------
- Extended some comments
- Added @todos to engines/engine.h
- Added a FIXME to engines/dialogs.cpp

Modified Paths:
--------------
    scummvm/trunk/engines/dialogs.cpp
    scummvm/trunk/engines/engine.h
    scummvm/trunk/engines/metaengine.h

Modified: scummvm/trunk/engines/dialogs.cpp
===================================================================
--- scummvm/trunk/engines/dialogs.cpp	2008-11-03 19:55:20 UTC (rev 34886)
+++ scummvm/trunk/engines/dialogs.cpp	2008-11-03 20:00:36 UTC (rev 34887)
@@ -144,6 +144,10 @@
 		int slot = _loadDialog->runModal(plugin, ConfMan.getActiveDomainName());
 
 		if (slot >= 0) {
+			// FIXME: For now we just ignore the return
+			// value, which is quite bad since it could
+			// be a fatal loading error, which renders
+			// the engine unusable.
 			_engine->loadGameState(slot);
 			close();
 		}

Modified: scummvm/trunk/engines/engine.h
===================================================================
--- scummvm/trunk/engines/engine.h	2008-11-03 19:55:20 UTC (rev 34886)
+++ scummvm/trunk/engines/engine.h	2008-11-03 20:00:36 UTC (rev 34887)
@@ -126,22 +126,28 @@
 	virtual void syncSoundSettings();
 
 	/** 
-	 * Load a game state 
+	 * Load a game state.
+	 * @return returns 0 on success, anything else indicates failure
+	 * @todo define proper error values
 	 */
 	virtual int loadGameState(int slot);
 
 	/**
-	 * Indicates whether a game state can be loaded 
+	 * Indicates whether a game state can be loaded.
 	 */
 	virtual bool canLoadGameStateCurrently();
 
 	/**
-	 * Save a game state 
+	 * Save a game state.
+	 * @return returns 0 on success, anything else indicates failure
+	 *
+	 * @todo define proper error values
+	 * @todo actually we need to pass the user entered name to the engine
 	 */
 	virtual int saveGameState(int slot);
 
 	/**
-	 * Indicates whether a game state can be saved
+	 * Indicates whether a game state can be saved.
 	 */
 	virtual bool canSaveGameStateCurrently();
 

Modified: scummvm/trunk/engines/metaengine.h
===================================================================
--- scummvm/trunk/engines/metaengine.h	2008-11-03 19:55:20 UTC (rev 34886)
+++ scummvm/trunk/engines/metaengine.h	2008-11-03 20:00:36 UTC (rev 34887)
@@ -186,12 +186,12 @@
 		kSavesSupportPlayTime,
 		
 		/** 
-		 *Features loading from the Common ScummVM options dialog in-game 
+		 * Features loading from the Common ScummVM options dialog in-game.
 		 */
 		kSupportsLoadingDuringRuntime,
 
 		/** 
-		 *Features saving from the Common ScummVM options dialog in-game 
+		 * Features saving from the Common ScummVM options dialog in-game.
 		 */
 		kSupportsSavingDuringRuntime
 	};	


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