Doxygen: Address warnings

Signed-off-by: Simon Rozman <simon@rozman.si>
This commit is contained in:
Simon Rozman 2022-02-04 14:28:18 +01:00
parent e3d9fffd4f
commit 21c1bf5084
5 changed files with 68 additions and 9 deletions

View File

@ -2198,7 +2198,7 @@ ENABLE_PREPROCESSING = YES
# The default value is: NO. # The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = NO MACRO_EXPANSION = YES
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# the macro expansion is limited to the macros specified with the PREDEFINED and # the macro expansion is limited to the macros specified with the PREDEFINED and
@ -2206,7 +2206,7 @@ MACRO_EXPANSION = NO
# The default value is: NO. # The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_ONLY_PREDEF = NO EXPAND_ONLY_PREDEF = YES
# If the SEARCH_INCLUDES tag is set to YES, the include files in the # If the SEARCH_INCLUDES tag is set to YES, the include files in the
# INCLUDE_PATH will be searched if a #include is found. # INCLUDE_PATH will be searched if a #include is found.
@ -2238,7 +2238,28 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator. # recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = PREDEFINED = \
_FormatMessage_format_string_= \
_Frees_ptr_opt_= \
_In_= \
_In_bytecount_(x)= \
_In_count_(x)= \
_In_opt_= \
_In_opt_count_(x)= \
_In_opt_z_= \
_In_reads_(x)= \
_In_reads_opt_(x)= \
_In_z_= \
_In_z_count_(x)= \
_Inout_= \
_Inout_count_(x)= \
_Inout_opt_= \
_Out_= \
_Out_opt_= \
_Out_z_cap_(x)= \
_Printf_format_string_= \
_Reserved_= \
_Success_(x)=
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The # tag can be used to specify a list of macro names that should be expanded. The

View File

@ -112,15 +112,39 @@ private: \
#define PRINTF_LPOLESTR "ls" #define PRINTF_LPOLESTR "ls"
#endif #endif
///
/// Standard input stream for TCHAR strings
///
#ifdef _UNICODE #ifdef _UNICODE
#define _tcin (std::wcin ) #define _tcin (std::wcin )
#else
#define _tcin (std::cin ) ///< Standard input stream for TCHAR strings
#endif
///
/// Standard output stream for TCHAR strings
///
#ifdef _UNICODE
#define _tcout (std::wcout) #define _tcout (std::wcout)
#else
#define _tcout (std::cout)
#endif
///
/// Standard error stream for TCHAR strings
///
#ifdef _UNICODE
#define _tcerr (std::wcerr) #define _tcerr (std::wcerr)
#else
#define _tcerr (std::cerr)
#endif
///
/// Standard logging stream for TCHAR strings
///
#ifdef _UNICODE
#define _tclog (std::wclog) #define _tclog (std::wclog)
#else #else
#define _tcin (std::cin )
#define _tcout (std::cout)
#define _tcerr (std::cerr)
#define _tclog (std::clog) #define _tclog (std::clog)
#endif #endif
@ -821,8 +845,6 @@ namespace winstd
} }
} }
/// @}
protected: protected:
/// ///
/// Abstract member function that must be implemented by child classes to do the actual object destruction. /// Abstract member function that must be implemented by child classes to do the actual object destruction.

View File

@ -84,20 +84,32 @@ namespace winstd
class window_dc : public handle<HDC, NULL> class window_dc : public handle<HDC, NULL>
{ {
public: public:
///
/// Initializes an empty device context.
///
window_dc() noexcept : window_dc() noexcept :
m_hwnd(NULL) m_hwnd(NULL)
{} {}
///
/// Initializes a device context from existing data.
///
window_dc(_In_opt_ handle_type h, _In_opt_ HWND hwnd) noexcept : window_dc(_In_opt_ handle_type h, _In_opt_ HWND hwnd) noexcept :
handle<handle_type, NULL>(h), handle<handle_type, NULL>(h),
m_hwnd(hwnd) m_hwnd(hwnd)
{} {}
///
/// Move an existing device context.
///
window_dc(_Inout_ window_dc &&h) noexcept : window_dc(_Inout_ window_dc &&h) noexcept :
handle<handle_type, NULL>(std::move(h)), handle<handle_type, NULL>(std::move(h)),
m_hwnd(h.m_hwnd) m_hwnd(h.m_hwnd)
{} {}
///
/// Copy an existing device context.
///
window_dc& operator=(_Inout_ window_dc &&h) noexcept window_dc& operator=(_Inout_ window_dc &&h) noexcept
{ {
handle<handle_type, NULL>::operator=(std::move(h)); handle<handle_type, NULL>::operator=(std::move(h));

View File

@ -144,10 +144,12 @@ namespace winstd
} }
protected: protected:
/// \cond internal
HDEVINFO m_DeviceInfoSet; HDEVINFO m_DeviceInfoSet;
PSP_DEVINFO_DATA m_DeviceInfoData; PSP_DEVINFO_DATA m_DeviceInfoData;
DWORD m_DriverType; DWORD m_DriverType;
BOOL m_result; ///< Did building succeed? BOOL m_result;
/// \endcond
}; };
/// @} /// @}

View File

@ -49,9 +49,11 @@ namespace winstd
} }
protected: protected:
/// \cond internal
HWND m_hwnd; HWND m_hwnd;
GUID m_action; GUID m_action;
WINTRUST_DATA &m_wtd; WINTRUST_DATA &m_wtd;
/// \endcond
}; };
/// @} /// @}