aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJaromir Wysoglad2019-08-16 20:33:45 +0200
committerFilippos Karapetis2019-08-24 18:12:45 +0300
commit05df774905d36203ef357963b74f3bf083b40aa3 (patch)
treea9196d6cd5b1d9cd7c1e4a01b1f9c22819091772
parent1346dcc3ef64e1a69a60800e7b8bef4d669846a6 (diff)
downloadscummvm-rg350-05df774905d36203ef357963b74f3bf083b40aa3.tar.gz
scummvm-rg350-05df774905d36203ef357963b74f3bf083b40aa3.tar.bz2
scummvm-rg350-05df774905d36203ef357963b74f3bf083b40aa3.zip
COMMON: Add OSystem::convertEncoding documentation
-rw-r--r--common/system.h16
1 files changed, 15 insertions, 1 deletions
diff --git a/common/system.h b/common/system.h
index 92fdfc5e1a..77bdcd0815 100644
--- a/common/system.h
+++ b/common/system.h
@@ -1493,7 +1493,21 @@ public:
//@}
- protected:
+protected:
+
+ /**
+ * This allows derived classes to implement encoding conversion using platform
+ * specific API.
+ * This method shouldn't be called directly. Use Common::Encoding instead.
+ *
+ * @param to Encoding to convert the string to
+ * @param from Encoding to convert the string from
+ * @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.
+ */
virtual char *convertEncoding(const char *to, const char *from, const char *string, size_t length) { return nullptr; }
};