From 4c4a127ca23ca55ec4f3348b40553ac5f72a3892 Mon Sep 17 00:00:00 2001
From: Filippos Karapetis
Date: Mon, 21 May 2012 23:17:28 +0300
Subject: COMMON: Add documentation regarding the new parameter in
 openForSaving()

---
 common/savefile.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

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;
-- 
cgit v1.2.3