Style unicode.cpp/h

No functional changes intended

Author: smowton

src/util/unicode.cpp

@@ -263,12 +263,36 @@ const char **narrow_argv(int argc, const wchar_t **argv_wide)
   return argv_narrow;
 }
 
+/*******************************************************************\
+
+Function: utf8_to_utf16_big_endian
+
+  Inputs: String in UTF-8 format
+
+ Outputs: String in UTF-16BE format
+
+ Purpose: Note this requires g++-5 libstdc++ / libc++ / MSVC2010+
+
+\*******************************************************************/
+
 std::wstring utf8_to_utf16_big_endian(const std::string& in)
 {
   std::wstring_convert<std::codecvt_utf8_utf16<wchar_t> > converter;
   return converter.from_bytes(in);
 }
 
+/*******************************************************************\
+
+Function: utf8_to_utf16_little_endian
+
+  Inputs: String in UTF-8 format
+
+ Outputs: String in UTF-16LE format
+
+ Purpose: Note this requires g++-5 libstdc++ / libc++ / MSVC2010+
+
+\*******************************************************************/
+
 std::wstring utf8_to_utf16_little_endian(const std::string& in)
 {
   const std::codecvt_mode mode=std::codecvt_mode::little_endian;
@@ -282,6 +306,19 @@ std::wstring utf8_to_utf16_little_endian(const std::string& in)
   return converter.from_bytes(in);
 }
 
+/*******************************************************************\
+
+Function: utf16_little_endian_to_ascii
+
+  Inputs: String in UTF-16LE format
+
+ Outputs: String in US-ASCII format, with \uxxxx escapes for other
+          characters
+
+ Purpose:
+
+\*******************************************************************/
+
 std::string utf16_little_endian_to_ascii(const std::wstring& in)
 {
   std::ostringstream result;

src/util/unicode.h

@@ -22,9 +22,9 @@ std::wstring widen(const std::string &s);
 std::string utf32_to_utf8(const std::basic_string<unsigned int> &s);
 std::string utf16_to_utf8(const std::basic_string<unsigned short int> &s);
 
-std::wstring utf8_to_utf16_big_endian(const std::string&);
-std::wstring utf8_to_utf16_little_endian(const std::string&);
-std::string utf16_little_endian_to_ascii(const std::wstring& in);
+std::wstring utf8_to_utf16_big_endian(const std::string &);
+std::wstring utf8_to_utf16_little_endian(const std::string &);
+std::string utf16_little_endian_to_ascii(const std::wstring &in);
 
 const char **narrow_argv(int argc, const wchar_t **argv_wide);