aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThierry Crozat2019-11-06 23:52:05 +0000
committerThierry Crozat2019-11-08 20:43:25 +0000
commit8ac0012fdde8fe0c380ecbff649bc32cff7a2a28 (patch)
treec7a8b3b3e0b0d1a2fc82c934665a03f9476cac6c
parent8b586ed4189ed58e43d77f7307d3f2b8f30ea20a (diff)
downloadscummvm-rg350-8ac0012fdde8fe0c380ecbff649bc32cff7a2a28.tar.gz
scummvm-rg350-8ac0012fdde8fe0c380ecbff649bc32cff7a2a28.tar.bz2
scummvm-rg350-8ac0012fdde8fe0c380ecbff649bc32cff7a2a28.zip
COMMON: Clarify documentation for OSystem::convertEncoding
-rw-r--r--common/system.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/common/system.h b/common/system.h
index 30c2ea9d63..0b75d906ad 100644
--- a/common/system.h
+++ b/common/system.h
@@ -1541,8 +1541,8 @@ protected:
* @param string The string that should be converted
* @param length Size of the string in bytes
*
- * @return Converted string, which must be freed, or nullptr if the conversion
- * isn't possible.
+ * @return Converted string, which must be freed by the caller (using free()
+ * and not delete[]), or nullptr if the conversion isn't possible.
*/
virtual char *convertEncoding(const char *to, const char *from, const char *string, size_t length) { return nullptr; }
};