diff options
| author | Egor Tensin <Egor.Tensin@gmail.com> | 2021-09-27 14:59:42 +0300 |
|---|---|---|
| committer | Egor Tensin <Egor.Tensin@gmail.com> | 2021-09-27 14:59:42 +0300 |
| commit | ccec9a29570b171206cafa404e8972dbe87c2567 (patch) | |
| tree | f289b10d36415bf4c73984c4c6b53b3673a1c241 /include | |
| parent | consistent Doxygen command prefix (diff) | |
| download | winapi-utf8-ccec9a29570b171206cafa404e8972dbe87c2567.tar.gz winapi-utf8-ccec9a29570b171206cafa404e8972dbe87c2567.zip | |
docs: refine Doxygen comments
Diffstat (limited to 'include')
| -rw-r--r-- | include/winapi/utf8.hpp | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/include/winapi/utf8.hpp b/include/winapi/utf8.hpp index f2cee4e..9259df6 100644 --- a/include/winapi/utf8.hpp +++ b/include/winapi/utf8.hpp @@ -19,16 +19,17 @@ namespace winapi { /** Convert UTF-8 string to UTF-16. */ std::wstring widen(const std::string&); + /** * Convert UTF-8 string to UTF-16. - * \param src Pointer to UTF-8 string. - * \param nb Number of bytes pointed to src. + * \param src Memory address of a UTF-8 string. + * \param nb String size (in bytes). */ std::wstring widen(const void* src, std::size_t nb); /** * Convert UTF-8 string to UTF-16. - * \param src UTF-8 string. + * \param src Buffer holding a UTF-8 string. */ template <typename T, typename Alloc = std::allocator<T>> std::wstring widen(const std::vector<T, Alloc>& src) { @@ -37,16 +38,17 @@ std::wstring widen(const std::vector<T, Alloc>& src) { /** Convert UTF-16 string to UTF-8. */ std::string narrow(const std::wstring&); + /** * Convert UTF-16 string to UTF-8. - * \param src Pointer to UTF-16 string. - * \param nb Number of bytes pointed to by src. + * \param src Memory address of a UTF-16 string. + * \param nb String size (in bytes). */ std::string narrow(const void* src, std::size_t nb); /** * Convert UTF-16 string to UTF-8. - * \param src UTF-16 string. + * \param src Buffer holding a UTF-16 string. */ template <typename T, typename Alloc = std::allocator<T>> std::string narrow(const std::vector<T, Alloc>& src) { |