aboutsummaryrefslogtreecommitdiff
path: root/common
diff options
context:
space:
mode:
Diffstat (limited to 'common')
-rw-r--r--common/savefile.h15
1 files changed, 12 insertions, 3 deletions
diff --git a/common/savefile.h b/common/savefile.h
index 1e48bafdfd..4dbb46c5eb 100644
--- a/common/savefile.h
+++ b/common/savefile.h
@@ -56,11 +56,20 @@ public:
}
};
+
/**
- * Convenience intermediate class, to be removed.
+ * The SaveFileManager is serving as a factor for InSaveFile
+ * and OutSaveFile objects.
+ *
+ * Engines and other code should use SaveFiles whenever they need to
+ * store data which they need to be able to retrieve later on --
+ * i.e. typically save states, but also configuration files and similar
+ * things.
+ *
+ * While not declared as a singleton,
+ * it is effectively used as such, with OSystem::getSavefileManager
+ * returning the single SaveFileManager instances to be used.
*/
-class SaveFile : public InSaveFile, public OutSaveFile {};
-
class SaveFileManager {
public: