yyc12345/YYCCommonplace
1
0
Fork 0
Code Issues Pull Requests Releases Activity

doc: add documentation for COMHelper

Browse Source
This commit is contained in:
yyc12345
2024-07-15 13:47:14 +08:00
parent 9f47d0fe24
commit b912be082c
4 changed files with 38 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/COMHelper.hpp
View File

@ -9,25 +9,6 @@
#include <shlobj_core.h>
#include "WinImportSuffix.hpp"
/**
* @brief COM fucntions related namespace.
* @details
* This namespace is Windows specific and is unavailable on other platforms.
*
* This namespace contain a COM Guard which make sure COM was initialized in current module when loading current module.
* It is essential because all calling to COM functions should be under the premise that COM has been initialized.
* This guard also will uninitialize COM when unloading this module.
*
* This namespace also provided various memory-safe types for interacting with COM functions.
* Although Microsoft also has similar smart pointer called \c CComPtr.
* But this library is eager to hide all Microsoft-related functions calling.
* Using \c CComPtr is not corresponding with the philosophy of this library.
* So these std-based smart pointer type were created.
*
* This namespace is used by internal functions as intended.
* They should not be used outside of this library.
* But if you compel to use them, it is also okey.
*/
namespace YYCC::COMHelper {
/**