From c24e752ec3d5fc6e051cce76d0cb64fa60c77b22 Mon Sep 17 00:00:00 2001 From: Thomas Bernard Date: Sat, 17 Feb 2018 17:23:44 +0100 Subject: [PATCH] unicode.h: Comment what we support about unicode --- src/unicode.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/unicode.h b/src/unicode.h index 1a54ebb0..349a79de 100644 --- a/src/unicode.h +++ b/src/unicode.h @@ -23,6 +23,16 @@ #include "struct.h" +////////////////////////////////////////////////////////////////////////////// +///@file unicode.h +/// Functions supporting Unicode text with 16 bits per characters. +/// It is just like UCS-2, using the native byte order. +/// This is not UTF16, as UTF16 encodes some characters using 2 16bit words. +/// But it matches UTF16 on all the other characters. +/// Also the "BOM" are not supported +////////////////////////////////////////////////////////////////////////////// + + /// equivalent of strlen() for out Unicode strings /// return the number of characters (words), so there is twice as much bytes size_t Unicode_strlen(const word * str);