Document blank argument to InitialiseLocale

Set it as the default value, as the system default is the most likely desired value, and this makes that more obvious.
This commit is contained in:
Oliver Hamlet
2017-12-30 14:54:10 +00:00
parent 4b4e2cf3d6
commit 8703425943
+3 -2
View File
@@ -99,9 +99,10 @@ LOOT_API bool IsCompatible(const unsigned int major,
*
* This sets the global locale up so that the library's UTF-8 support can
* function.
* @param id A locale ID.
* @param id A locale ID. The default value is a blank string, which will
* use the system default locale.
*/
LOOT_API void InitialiseLocale(const std::string& id);
LOOT_API void InitialiseLocale(const std::string& id = "");
/**
* @brief Initialise a new game handle.