From abd1f36d19f9be9ca1efc66ae7a642dd227b1f3c Mon Sep 17 00:00:00 2001 From: Eric Biggers Date: Tue, 26 Mar 2013 12:40:39 -0500 Subject: [PATCH] wimlib.h: Doc fixes --- src/wimlib.h | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/src/wimlib.h b/src/wimlib.h index b23bb405..1ccdd3b3 100644 --- a/src/wimlib.h +++ b/src/wimlib.h @@ -191,16 +191,16 @@ * \section encodings Locales and character encodings * * To support Windows as well as UNIX, wimlib's API typically takes and returns - * strings of "tchars", which are in a platform-dependent encoding. + * strings of ::wimlib_tchar, which are in a platform-dependent encoding. * - * On Windows, each "tchar" is 2 bytes and is the same as a "wchar_t", and the - * encoding is UTF-16LE. + * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t", + * and the encoding is UTF-16LE. * - * On UNIX, each "tchar" is 1 byte and is simply a "char", and the encoding is - * the locale-dependent multibyte encoding. I recommend you set your locale to a - * UTF-8 capable locale to avoid any issues. Also, by default, wimlib on UNIX - * will assume the locale is UTF-8 capable unless you call wimlib_global_init() - * after having set your desired locale. + * On UNIX, each ::wimlib_tchar is 1 byte and is simply a "char", and the +* encoding is the locale-dependent multibyte encoding. I recommend you set your +* locale to a UTF-8 capable locale to avoid any issues. Also, by default, + * wimlib on UNIX will assume the locale is UTF-8 capable unless you call +* wimlib_global_init() after having set your desired locale. * * \section Limitations * @@ -210,8 +210,7 @@ * without mounting it, other than by adding, removing, or extracting an * entire image. The FUSE mount feature should be used for this purpose. * - Currently, Microsoft's @a image.exe can create slightly smaller WIM files - * than wimlib when using maximum (LZX) compression because it knows how to - * split up LZX compressed blocks, which is not yet implemented in wimlib. + * than wimlib (~2% or 3% smaller) when using maximum (LZX) compression. * - wimlib is experimental and likely contains bugs; use Microsoft's @a * imagex.exe if you want to make sure your WIM files are made "correctly". * - The old WIM format from Vista pre-releases is not supported. @@ -274,6 +273,7 @@ typedef struct WIMStruct WIMStruct; #ifdef __WIN32__ typedef wchar_t wimlib_tchar; #else +/** See \ref encodings */ typedef char wimlib_tchar; #endif -- 2.43.0