io.encodings.utf16: add a utf16n word for native utf16 type.

[factor.git] / core / io / encodings / utf16 / utf16-docs.factor

diff --git a/core/io/encodings/utf16/utf16-docs.factor b/core/io/encodings/utf16/utf16-docs.factor
index 4e8e778edfcf83c7cd4aa584fdd73468b14ce2cb..5ef968a97b38292c4d4a55e821cc2e84e164dcf9 100644 (file)
--- a/core/io/encodings/utf16/utf16-docs.factor
+++ b/core/io/encodings/utf16/utf16-docs.factor
@@ -9,6 +9,7 @@ ARTICLE: "io.encodings.utf16" "UTF-16 encoding"
     utf16
     utf16le
     utf16be
+    utf16n
 } ;
 
 ABOUT: "io.encodings.utf16"
@@ -25,4 +26,8 @@ HELP: utf16
 { $class-description "The encoding descriptor for UTF-16, that is, UTF-16 with a byte order mark. This is the most useful for general input and output in UTF-16. Streams can be made which read or write wth this encoding." }
 { $see-also "encodings-introduction" } ;
 
-{ utf16 utf16le utf16be } related-words
+HELP: utf16n
+{ $description "The encoding descriptor for UTF-16 without a byte order mark in native endian order. This is useful mostly for FFI calls which take input of strings of the type " { $snippet "wchar_t*" } "." }
+{ $see-also "encodings-introduction" } ;
+
+{ utf16 utf16le utf16be utf16n } related-words