yyc12345/YYCCommonplace
1
0
Fork 0
Code Activity

doc: fix doc for winfct

Browse Source
This commit is contained in:
yyc12345
2026-01-13 13:24:18 +08:00
parent 2b6ac98f27
commit 215a8ce8b8
3 changed files with 32 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
doc/src/index.dox
View File

@@ -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>

23
doc/src/windows/win_fct_helper.dox
View File

@@ -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.
*/
}

15
doc/src/windows/winfct.dox Normal file
View File

@@ -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.
*/
}