yyc12345/YYCCommonplace
1
0
Fork 0
Code Issues Pull Requests Releases Activity

doc: add Doxygen comment

Browse Source
This commit is contained in:
yyc12345
2025-08-12 16:15:00 +08:00
parent 8dbe32cb8e
commit cfbc3c68e0
3 changed files with 36 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/yycc/encoding/stl.hpp
View File

@ -14,29 +14,29 @@ namespace yycc::encoding::stl {
/**
* @brief UTF8 -> UTF16
* @param src
* @return
* @param[in] src The string to be converted.
* @return The converted string, or error occurring.
*/
ConvResult<std::u16string> to_utf16(const std::u8string_view& src);
/**
* @brief UTF16 -> UTF8
* @param src
* @return
* @param[in] src The string to be converted.
* @return The converted string, or error occurring.
*/
ConvResult<std::u8string> to_utf8(const std::u16string_view& src);
/**
* @brief UTF8 -> UTF32
* @param src
* @return
* @param[in] src The string to be converted.
* @return The converted string, or error occurring.
*/
ConvResult<std::u32string> to_utf32(const std::u8string_view& src);
/**
* @brief UTF32 -> UTF8
* @param src
* @return
* @param[in] src The string to be converted.
* @return The converted string, or error occurring.
*/
ConvResult<std::u8string> to_utf8(const std::u32string_view& src);