From 983acd5dc0921105cceade062553bc9c826dfd8d Mon Sep 17 00:00:00 2001
From: Alexander Grund <Flamefire@users.noreply.github.com>
Date: Wed, 8 Jan 2020 13:08:13 +0100
Subject: [PATCH] Document utf8_codecvt

---
 include/boost/nowide/utf8_codecvt.hpp | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/include/boost/nowide/utf8_codecvt.hpp b/include/boost/nowide/utf8_codecvt.hpp
index f5af170..68a31b0 100644
--- a/include/boost/nowide/utf8_codecvt.hpp
+++ b/include/boost/nowide/utf8_codecvt.hpp
@@ -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;