diff --git a/doc/src/index.dox b/doc/src/index.dox index bdf02a6..e82db87 100644 --- a/doc/src/index.dox +++ b/doc/src/index.dox @@ -45,26 +45,27 @@ \li \subpage patch - - - - Advanced Features (Carton) + + Windows Specific Features \li \subpage windows__import_guard @@ -73,11 +74,7 @@ \li \subpage windows__dialog - + \li \subpage windows__winfct diff --git a/doc/src/windows/win_fct_helper.dox b/doc/src/windows/win_fct_helper.dox deleted file mode 100644 index eaa6246..0000000 --- a/doc/src/windows/win_fct_helper.dox +++ /dev/null @@ -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. - -*/ -} \ No newline at end of file diff --git a/doc/src/windows/winfct.dox b/doc/src/windows/winfct.dox new file mode 100644 index 0000000..d23d248 --- /dev/null +++ b/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. + +*/ +} \ No newline at end of file