yyc12345/YYCCommonplace
1
0
Fork 0
Code Activity

doc: fix doxygen issue

Browse Source
This commit is contained in:
yyc12345
2026-01-13 14:33:37 +08:00
parent 215a8ce8b8
commit 6dfd957ce9
2 changed files with 5 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/yycc/windows/dialog.hpp
View File

@@ -23,7 +23,7 @@
* @brief The namespace providing Windows universal dialog features. * @brief The namespace providing Windows universal dialog features.
* @details * @details
* This namespace only available on Windows platform. * This namespace only available on Windows platform.
* See also \ref dialog_helper. * See also \ref windows__dialog.
*/ */
namespace yycc::windows::dialog { namespace yycc::windows::dialog {
@@ -194,7 +194,7 @@ namespace yycc::windows::dialog {
* @brief The class representing the file dialog. * @brief The class representing the file dialog.
* @details * @details
* This class is served for programming using to describe every aspectes of the dialog. * This class is served for programming using to describe every aspectes of the dialog.
* For how to use this struct, see \ref dialog_helper. * For how to use this struct, see \ref windows__dialog.
*/ */
class FileDialog { class FileDialog {
public: public:

8
src/yycc/windows/winfct.hpp
View File

@@ -49,7 +49,6 @@ namespace yycc::windows::winfct {
* @param[in] hModule * @param[in] hModule
* The HANDLE to the module where you want to get file name. * The HANDLE to the module where you want to get file name.
* It is same as the HANDLE parameter of Win32 \c GetModuleFileName. * It is same as the HANDLE parameter of Win32 \c GetModuleFileName.
* @param[out] ret The variable receiving UTF8 encoded file name of given module.
* @return Fetched UTF8 encoded file name of given module, or error occurs. * @return Fetched UTF8 encoded file name of given module, or error occurs.
*/ */
WinFctResult<std::u8string> get_module_file_name(HINSTANCE hModule); WinFctResult<std::u8string> get_module_file_name(HINSTANCE hModule);
@@ -101,10 +100,9 @@ namespace yycc::windows::winfct {
}; };
/** /**
* @brief Get the path to \%LOCALAPPDATA\%. * @brief Get the path to known directory in Windows.
* @details \%LOCALAPPDATA\% usually was used as putting local app data files * @param[in] path_type The type of known directory.
* @param[out] ret The variable receiving UTF8 encoded path to LOCALAPPDATA. * @return The result type containing either fetched path, or error occurs.
* @return True if success, otherwise false.
*/ */
WinFctResult<std::u8string> get_known_path(KnownDirectory path_type); WinFctResult<std::u8string> get_known_path(KnownDirectory path_type);