aboutsummaryrefslogtreecommitdiff
path: root/engines/engine.h
diff options
context:
space:
mode:
authorJohannes Schickel2008-11-03 20:00:36 +0000
committerJohannes Schickel2008-11-03 20:00:36 +0000
commit112feada4e68ecae1bdbd380f9b8d4fac15bd396 (patch)
tree7f4e20e2b2e18074cc35cbad160deb9b0abb7edb /engines/engine.h
parent39a1eb8191cbef6dc22dc8e947daf01a0617fd28 (diff)
downloadscummvm-rg350-112feada4e68ecae1bdbd380f9b8d4fac15bd396.tar.gz
scummvm-rg350-112feada4e68ecae1bdbd380f9b8d4fac15bd396.tar.bz2
scummvm-rg350-112feada4e68ecae1bdbd380f9b8d4fac15bd396.zip
- Extended some comments
- Added @todos to engines/engine.h - Added a FIXME to engines/dialogs.cpp svn-id: r34887
Diffstat (limited to 'engines/engine.h')
-rw-r--r--engines/engine.h14
1 files changed, 10 insertions, 4 deletions
diff --git a/engines/engine.h b/engines/engine.h
index 90eea859ef..b8904d56c4 100644
--- a/engines/engine.h
+++ b/engines/engine.h
@@ -126,22 +126,28 @@ public:
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();