From 6dfd957ce9553e7fe9760c58b44244196645d766 Mon Sep 17 00:00:00 2001 From: yyc12345 Date: Tue, 13 Jan 2026 14:33:37 +0800 Subject: [PATCH] doc: fix doxygen issue --- src/yycc/windows/dialog.hpp | 4 ++-- src/yycc/windows/winfct.hpp | 8 +++----- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/src/yycc/windows/dialog.hpp b/src/yycc/windows/dialog.hpp index 4de1cb2..c816d92 100644 --- a/src/yycc/windows/dialog.hpp +++ b/src/yycc/windows/dialog.hpp @@ -23,7 +23,7 @@ * @brief The namespace providing Windows universal dialog features. * @details * This namespace only available on Windows platform. - * See also \ref dialog_helper. + * See also \ref windows__dialog. */ namespace yycc::windows::dialog { @@ -194,7 +194,7 @@ namespace yycc::windows::dialog { * @brief The class representing the file dialog. * @details * 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 { public: diff --git a/src/yycc/windows/winfct.hpp b/src/yycc/windows/winfct.hpp index f0b46f6..f6cf55b 100644 --- a/src/yycc/windows/winfct.hpp +++ b/src/yycc/windows/winfct.hpp @@ -49,7 +49,6 @@ namespace yycc::windows::winfct { * @param[in] hModule * The HANDLE to the module where you want to get file name. * 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. */ WinFctResult get_module_file_name(HINSTANCE hModule); @@ -101,10 +100,9 @@ namespace yycc::windows::winfct { }; /** - * @brief Get the path to \%LOCALAPPDATA\%. - * @details \%LOCALAPPDATA\% usually was used as putting local app data files - * @param[out] ret The variable receiving UTF8 encoded path to LOCALAPPDATA. - * @return True if success, otherwise false. + * @brief Get the path to known directory in Windows. + * @param[in] path_type The type of known directory. + * @return The result type containing either fetched path, or error occurs. */ WinFctResult get_known_path(KnownDirectory path_type);