commit be6a67eb

sago007 · 2018-05-27 13:12
be6a67eb1e3c0778e3ed24f48d823058b35635fe patch · browse files
parent bc48900abbdcf0e7af4a61d2f9e933069b735429

Updated the documentation to refer to the new calling convention

Changed files

M	sago/platform_folders.h before

diff --git a/sago/platform_folders.h b/sago/platform_folders.h index 824e725..bd6c0d5 100644 --- a/sago/platform_folders.h +++ b/sago/platform_folders.h

@@ -151,8 +151,7 @@ std::string getVideoFolder();

* The base folder for storring saved games.

* You must add the program name to it like this:

* @code{.cpp}

- * PlatformFolders pf;

- * string saved_games_folder = pf.getSaveGamesFolder1()+"/My Program Name/";

+ * string saved_games_folder = sago::getSaveGamesFolder1()+"/My Program Name/";

* @endcode

* @note Windows: This is an XP compatible version and returns the path to "My Games" in Documents. Vista and later has an official folder.

* @note Linux: XDF does not define a folder for saved games. This will just return the same as GetDataHome()