2
0
mirror of https://github.com/boostorg/nowide.git synced 2026-02-22 03:22:32 +00:00

Document utf8_codecvt

This commit is contained in:
Alexander Grund
2020-01-08 13:08:13 +01:00
parent 999893c4e6
commit 983acd5dc0

View File

@@ -27,6 +27,12 @@ namespace nowide {
#define BOOST_NOWIDE_DO_LENGTH_MBSTATE_CONST
#endif
/// std::codecvt implementation that converts between UTF-8 and UTF-16 or UTF-32
///
/// @tparam CharSize Determines the encoding: 2 for UTF-16, 4 for UTF-32
///
/// Invalid sequences are replaced by #BOOST_NOWIDE_REPLACEMENT_CHARACTER
/// A trailing incomplete sequence will result in a return value of std::codecvt::partial
template<typename CharType, int CharSize = sizeof(CharType)>
class utf8_codecvt;