COMMON: Beautify SaveFileManager documentation.

common/savefile.h

@@ -115,49 +115,56 @@ class SaveFileManager : NonCopyable {
 	 * exports from the Quest for Glory series. QfG5 is a 3D game and won't be
 	 * supported by ScummVM.
 	 *
-	 * @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.
+	 * @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;
 
 	/**
 	 * Open the file with the specified name in the given directory for loading.
-	 * @param name	the name of the savefile
-	 * @return pointer to an InSaveFile, or NULL if an error occurred.
+	 *
+	 * @param name  The name of the savefile.
+	 * @return Pointer to an InSaveFile, or NULL if an error occurred.
 	 */
 	virtual InSaveFile *openForLoading(const String &name) = 0;
 
 	/**
 	 * Removes the given savefile from the system.
-	 * @param name the name of the savefile to be removed.
+	 *
+	 * @param name  The name of the savefile to be removed.
 	 * @return true if no error occurred, false otherwise.
 	 */
 	virtual bool removeSavefile(const String &name) = 0;
 
 	/**
 	 * Renames the given savefile.
-	 * @param oldName Old name.
-	 * @param newName New name.
+	 *
+	 * @param oldName  Old name.
+	 * @param newName  New name.
 	 * @return true if no error occurred. false otherwise.
 	 */
 	virtual bool renameSavefile(const String &oldName, const String &newName);
 
 	/**
 	 * Copy the given savefile.
-	 * @param oldName Old name.
-	 * @param newName New name.
+	 *
+	 * @param oldName  Old name.
+	 * @param newName  New name.
 	 * @return true if no error occurred. false otherwise.
 	 */
 	virtual bool copySavefile(const String &oldName, const String &newName);
 
 	/**
-	 * Request a list of available savegames with a given DOS-style pattern,
-	 * also known as "glob" in the POSIX world. Refer to the Common::matchString()
-	 * function to learn about the precise pattern format.
-	 * @param pattern Pattern to match. Wildcards like * or ? are available.
-	 * @return list of strings for all present file names.
+	 * List available savegames matching a given pattern.
+	 *
+	 * Our pattern format is based on DOS paterns, also known as "glob" in the
+	 * POSIX world. Please refer to the Common::matchString() function to learn
+	 * about the precise pattern format.
+	 *
+	 * @param pattern  Pattern to match. Wildcards like * or ? are available.
+	 * @return List of strings for all present file names.
 	 * @see Common::matchString()
 	 */
 	virtual StringArray listSavefiles(const String &pattern) = 0;