From b20922942c6a567324eb40dfb2367fe1192e173e Mon Sep 17 00:00:00 2001 From: Jaromir Wysoglad Date: Thu, 15 Aug 2019 16:20:31 +0200 Subject: [PATCH] COMMON: Add missing documentation. --- common/encoding.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/common/encoding.h b/common/encoding.h index 309e0f8a37b..70ba2bfe447 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); };