aboutsummaryrefslogtreecommitdiff
path: root/common/encoding.h
diff options
context:
space:
mode:
authorJaromir Wysoglad2019-08-15 16:20:31 +0200
committerFilippos Karapetis2019-08-24 18:12:45 +0300
commitb20922942c6a567324eb40dfb2367fe1192e173e (patch)
tree50684abf2d2813dbf2d999c3b18784ad00e517c3 /common/encoding.h
parent96270d4bf23aa77bcda5ec98b808dcd26931e0b1 (diff)
downloadscummvm-rg350-b20922942c6a567324eb40dfb2367fe1192e173e.tar.gz
scummvm-rg350-b20922942c6a567324eb40dfb2367fe1192e173e.tar.bz2
scummvm-rg350-b20922942c6a567324eb40dfb2367fe1192e173e.zip
COMMON: Add missing documentation.
Diffstat (limited to 'common/encoding.h')
-rw-r--r--common/encoding.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/common/encoding.h b/common/encoding.h
index 309e0f8a37..70ba2bfe44 100644
--- a/common/encoding.h
+++ b/common/encoding.h
@@ -222,6 +222,16 @@ class Encoding {
*/
static void deinitIconv(iconv_t iconvHandle);
+ /**
+ * If the string is "utf-16" or "utf-32", this adds either BE for big endian
+ * or LE for little endian to the end of the string. Otherwise this does
+ * nothing.
+ *
+ * @param str String to append the endianness to
+ *
+ * @return The same string with appended endianness if it is needed, or
+ * the same string.
+ */
static String addUtfEndianness(const String &str);
};