doc: fix doxygen issue

doc/src/index.dox

@@ -45,26 +45,27 @@
 
     \li \subpage patch
 
-    <!--
-    \li \subpage encoding_helper
-
-    \li \subpage console_helper
-
-    -->
-
-    <!--
-    \li \subpage constraints
-
-    \li \subpage config_manager
-
-    \li \subpage arg_parser
-    -->
-
   </TD>
   <TD ALIGN="LEFT" VALIGN="TOP">
 
     <B>Advanced Features (Carton)</B>
 
+    <!--
+    
+    \li \subpage constraints
+
+    \li \subpage encoding_helper
+
+    \li \subpage console_helper
+
+    \li \subpage config_manager
+
+    \li \subpage arg_parser
+
+    \li \subpage exception_helper
+
+    -->
+
     <B>Windows Specific Features</B>
 
     \li \subpage windows__import_guard
@@ -73,11 +74,7 @@
 
     \li \subpage windows__dialog
 
-    <!--
-    \li \subpage win_fct_helper
-
-    \li \subpage exception_helper
-    -->
+    \li \subpage windows__winfct
 
   </TD>
 </TR>

doc/src/windows/win_fct_helper.dox

@@ -1,23 +0,0 @@
-namespace YYCC::WinFctHelper {
-/**
-
-\page win_fct_helper Windows Function Helper
-
-This helper give a more convenient way to call Windows functions.
-
-This namespace is Windows specific.
-It will be entirely invisible in other platforms.
-
-Currently this namespace has following functions:
-
-\li #GetCurrentModule: Get the handle to current module.
-\li #GetTempDirectory: Get temporary directory in Windows.
-\li #GetModuleFileName: Get the path to module in file system by given handle.
-\li #GetLocalAppData: Get the path inside \%LOCALAPPDATA\%
-\li #IsValidCodePage: Check whether given code page number is valid.
-\li #CopyFile: The UTF8 version of Win32 \c CopyFile.
-\li #MoveFile: The UTF8 version of Win32 \c MoveFile.
-\li #DeleteFile: The UTF8 version of Win32 \c DeleteFile.
-
-*/
-}

doc/src/windows/winfct.dox

@@ -0,0 +1,15 @@
+namespace yycc::windows::winfct {
+/**
+
+\page windows__winfct Windows Function Helper
+
+Namespace yycc::windows::winfct gives a more convenient way to call Windows functions.
+If you want to know how to use these functions, please read the documentation of each function.
+The return value of most functions is a specific result type.
+If any error occurs, the result type will be an error, otherwise it will be the true result.
+
+This namespace is Windows specific.
+It will be entirely invisible in other platforms.
+
+*/
+}

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:

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<std::u8string> 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<std::u8string> get_known_path(KnownDirectory path_type);