aboutsummaryrefslogtreecommitdiff
path: root/common
diff options
context:
space:
mode:
authorFilippos Karapetis2012-05-21 23:17:28 +0300
committerFilippos Karapetis2012-06-21 10:48:04 +0300
commit4c4a127ca23ca55ec4f3348b40553ac5f72a3892 (patch)
tree1e006ee2f71f3114f7ccd96421788984df4ba3bc /common
parente10e412bba99090b67a99cd7fddd5405172452f1 (diff)
downloadscummvm-rg350-4c4a127ca23ca55ec4f3348b40553ac5f72a3892.tar.gz
scummvm-rg350-4c4a127ca23ca55ec4f3348b40553ac5f72a3892.tar.bz2
scummvm-rg350-4c4a127ca23ca55ec4f3348b40553ac5f72a3892.zip
COMMON: Add documentation regarding the new parameter in openForSaving()
Diffstat (limited to 'common')
-rw-r--r--common/savefile.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/common/savefile.h b/common/savefile.h
index 3aa0f423e3..2f4b8a2d5b 100644
--- a/common/savefile.h
+++ b/common/savefile.h
@@ -105,7 +105,8 @@ public:
/**
* Open the savefile with the specified name in the given directory for saving.
- * @param name the name of the savefile
+ * @param name the name of the savefile
+ * @param compress toggles whether to compress the resulting save file (default) or not.
* @return pointer to an OutSaveFile, or NULL if an error occurred.
*/
virtual OutSaveFile *openForSaving(const String &name, bool compress = true) = 0;