From 8703425943fc41394edb986cfbdc79eeaff799cc Mon Sep 17 00:00:00 2001 From: Oliver Hamlet Date: Sat, 30 Dec 2017 13:49:16 +0000 Subject: [PATCH] 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. --- include/loot/api.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/include/loot/api.h b/include/loot/api.h index a2e54570..6d99865b 100644 --- a/include/loot/api.h +++ b/include/loot/api.h @@ -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.