From 1ced56fee7a90ff79cf97f34f3721f7234f2f9bc Mon Sep 17 00:00:00 2001
From: RichieSams
Date: Sat, 21 Sep 2013 00:09:05 -0500
Subject: ZVISION: Add documentation to SaveManager

---
 engines/zvision/save_manager.h | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'engines/zvision')

diff --git a/engines/zvision/save_manager.h b/engines/zvision/save_manager.h
index 8d0ebc75af..6445f10caf 100644
--- a/engines/zvision/save_manager.h
+++ b/engines/zvision/save_manager.h
@@ -56,8 +56,27 @@ private:
 	};
 
 public:
+	/**
+	 * Called every room change. Saves the state of the room just before
+	 * we switched rooms. Uses ZVision::generateAutoSaveFileName() to 
+	 * create the save file name.
+	 */
 	void autoSave();
+	/**
+	 * Copies the data from the last auto-save into a new save file. We
+	 * can't use the current state data because the save menu *IS* a room.
+	 * The file is named using ZVision::generateSaveFileName(slot)
+	 *
+	 * @param slot        The save slot this save pertains to. Must be [1, 20]
+	 * @param saveName    The internal name for this save. This is NOT the name of the actual save file.
+	 */
 	void saveGame(uint slot, const Common::String &saveName);
+	/**
+	 * Loads the state data from the save file that slot references. Uses
+	 * ZVision::generateSaveFileName(slot) to get the save file name.
+	 *
+	 * @param slot    The save slot to load. Must be [1, 20]
+	 */
 	Common::Error loadGame(uint slot);
 
 private:
-- 
cgit v1.2.3