[refactor enhance] Add a note about unicode functions

mthouv · Jun 14, 2018 · be2077a · be2077a
1 parent d0390e0
commit be2077a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/unitex/src/fr/umlv/unitex/io/UnicodeIO.java b/unitex/src/fr/umlv/unitex/io/UnicodeIO.java
@@ -27,6 +27,11 @@
 
 /**
  * This class provides methods for loading and saving UTF-16LE texts.
+ *
+ * Attention: Only use unicode functions that are available throughout this
+ * class. This is very important, since IO functions do not have the same 
+ * behavior on little-endian and big-endian systems. If you miss a function,
+ * please code it from the primitive functions of this library. 
  * 
  * @author Sébastien Paumier
  */