Amebis/wxExtend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doxygen support added

Browse Source
This commit is contained in:
Simon Rozman 2016-04-11 13:52:23 +02:00
parent 1ca2510ae1
commit 7627cabc1b
6 changed files with 2364 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -1,2 +1,3 @@
/doc
*.user
temp

2312
Doxyfile Normal file
View File

File diff suppressed because it is too large Load Diff

38
include/wxex/appbar.h
View File

@ -123,15 +123,15 @@ public:
/// Returns whether application bar is displayed always on top.
///
/// \returns
/// - true when application bar is always on top
/// - false otherwise
/// - \c true when application bar is always on top
/// - \c false otherwise
///
inline bool IsAlwaysOnTop() const;
///
/// Sets whether application bar is displayed always on top.
///
/// \param[in] alwaysOnTop Logical variable to control whether always-on-top behaviour is to be enabled (true) or disabled (false).
/// \param[in] alwaysOnTop Logical variable to control whether always-on-top behaviour is to be enabled (\c true) or disabled (\c false).
///
inline bool SetAlwaysOnTop(bool alwaysOnTop = true);
@ -139,15 +139,15 @@ public:
/// Returns if application bar is configured for auto-hide.
///
/// \returns
/// - true if application bar is configured for auto-hide
/// - false otherwise
/// - \c true if application bar is configured for auto-hide
/// - \c false otherwise
///
inline bool IsAutoHide() const;
///
/// Sets whether application bar is displayed always on top.
///
/// \param[in] autoHide Logical variable to control whether auto-hide behaviour is to be enabled (true) or disabled (false).
/// \param[in] autoHide Logical variable to control whether auto-hide behaviour is to be enabled (\c true) or disabled (\c false).
///
inline bool SetAutoHide(bool autoHide = true);
@ -155,15 +155,15 @@ public:
/// Returns if sizing of the application bar is allowed.
///
/// \returns
/// - true if sizing of the application bar is allowed
/// - false otherwise
/// - \c true if sizing of the application bar is allowed
/// - \c false otherwise
///
inline bool GetAllowSizing() const;
///
/// Sets whether resizing of the application bar is allowed.
///
/// \param[in] allow Logical variable to control whether resizing is to be enabled (true) or disabled (false).
/// \param[in] allow Logical variable to control whether resizing is to be enabled (\c true) or disabled (\c false).
///
inline bool SetAllowSizing(bool allow = true);
@ -171,8 +171,8 @@ public:
/// Returns if application bar is auto-hidden right now.
///
/// \returns
/// - true if application bar is auto-hidden right now
/// - false otherwise
/// - \c true if application bar is auto-hidden right now
/// - \c false otherwise
inline bool GetAutoHidden() const;
//bool GetAppBarPlacement(LPAPPBARPLACEMENT lpPlacement) const;
@ -198,7 +198,7 @@ public:
///
/// Shows or hides auto-hide application bar.
///
/// \param[in] show Logical variable to control whether application bar is be shown (true) or hidden (false).
/// \param[in] show Logical variable to control whether application bar is be shown (\c true) or hidden (\c false).
///
void ShowAutoHideAppBar(bool show = true);
@ -236,7 +236,7 @@ protected:
///
/// Derived classes can implement their own. However, overriden virtual method should call the parent's implementation too.
///
/// \param[in] beginning true when windows arrangement starts and false when arrangement ends.
/// \param[in] beginning \c true when windows arrangement starts and \c false when arrangement ends.
///
virtual void OnWindowsArrange(bool beginning);
@ -340,8 +340,8 @@ public:
/// \param[in] state The state of the application bar
///
/// \returns
/// - true if the application bar state represents docked state
/// - false otherwise
/// - \c true if the application bar state represents docked state
/// - \c false otherwise
///
inline bool wxAppBarIsDocked(wxAppBarState state)
{
@ -355,8 +355,8 @@ inline bool wxAppBarIsDocked(wxAppBarState state)
/// \param[in] state The state of the application bar
///
/// \returns
/// - true if the application bar state represents vertically docked state
/// - false otherwise
/// - \c true if the application bar state represents vertically docked state
/// - \c false otherwise
///
inline bool wxAppBarIsDockedVert(wxAppBarState state)
{
@ -370,8 +370,8 @@ inline bool wxAppBarIsDockedVert(wxAppBarState state)
/// \param[in] state The state of the application bar
///
/// \returns
/// - true if the application bar state represents horizontally docked state
/// - false otherwise
/// - \c true if the application bar state represents horizontally docked state
/// - \c false otherwise
///
inline bool wxAppBarIsDockedHoriz(wxAppBarState state)
{

8
include/wxex/common.h
View File

@ -65,8 +65,8 @@
/// Returns whether windows animation is enabled.
///
/// \returns
/// - true when window animation is enabled
/// - false otherwise
/// - \c true when window animation is enabled
/// - \c false otherwise
///
inline bool wxGetDoWndAnimation()
{
@ -85,8 +85,8 @@ inline bool wxGetDoWndAnimation()
/// \param[in] nFlags Additional SWP_ flags to pass to SetWindowPos(). If zero, SetWindowPos() is not called.
///
/// \returns
/// - true when the window extended style was modified
/// - false if the window extended style was not neccessary
/// - \c true when the window extended style was modified
/// - \c false if the window extended style was not neccessary
///
inline bool wxModifyStyleEx(_In_ WXHWND hWnd, _In_ DWORD dwRemove, _In_ DWORD dwAdd, _In_ UINT nFlags = 0)
{

8
include/wxex/comutils.h
View File

@ -44,8 +44,8 @@ public:
/// Has the initialization been successful? (explicit test)
///
/// \returns
/// - true if initialization succeeded
/// - false otherwise
/// - \c true if initialization succeeded
/// - \c false otherwise
///
bool IsOk() const { return m_ok; }
@ -53,8 +53,8 @@ public:
/// Has the initialization been successful? (implicit test)
///
/// \returns
/// - true if initialization succeeded
/// - false otherwise
/// - \c true if initialization succeeded
/// - \c false otherwise
///
operator bool() const { return m_ok; }

48
include/wxex/crypto.h
View File

@ -45,8 +45,8 @@ public:
/// Has the session creation been successful?
///
/// \returns
/// - true if creation succeeded
/// - false otherwise
/// - \c true if creation succeeded
/// - \c false otherwise
///
inline bool IsOk() const
{
@ -91,8 +91,8 @@ public:
/// Has the hash creation been successful?
///
/// \returns
/// - true if creation succeeded
/// - false otherwise
/// - \c true if creation succeeded
/// - \c false otherwise
///
inline bool IsOk() const
{
@ -116,8 +116,8 @@ public:
/// \param[in] size Size of memory block in bytes
///
/// \returns
/// - true if hashing succeeded
/// - false otherwise
/// - \c true if hashing succeeded
/// - \c false otherwise
///
bool Hash(const void *data, size_t size);
@ -128,8 +128,8 @@ public:
/// \param[in] data Memory block
///
/// \returns
/// - true if hashing succeeded
/// - false otherwise
/// - \c true if hashing succeeded
/// - \c false otherwise
///
inline bool Hash(const wxMemoryBuffer &data)
{
@ -143,8 +143,8 @@ public:
/// \param[in] str String to hash
///
/// \returns
/// - true if hashing succeeded
/// - false otherwise
/// - \c true if hashing succeeded
/// - \c false otherwise
///
inline bool HashAsUTF8(const wxString &str)
{
@ -159,8 +159,8 @@ public:
/// \param[in] fileName The path of the file to calculate hash of
///
/// \returns
/// - true if hashing succeeded
/// - false otherwise
/// - \c true if hashing succeeded
/// - \c false otherwise
///
inline bool HashFile(const wxString &fileName)
{
@ -186,8 +186,8 @@ public:
/// \param[out] hash Hash data
///
/// \returns
/// - true if succeeded
/// - false otherwise
/// - \c true if succeeded
/// - \c false otherwise
///
virtual bool GetValue(wxMemoryBuffer &hash);
@ -198,8 +198,8 @@ public:
/// \param[out] signature Digital signature
///
/// \returns
/// - true if signing succeeded
/// - false otherwise
/// - \c true if signing succeeded
/// - \c false otherwise
///
bool Sign(wxMemoryBuffer &signature);
@ -233,8 +233,8 @@ public:
/// \param[out] hash Hash data
///
/// \returns
/// - true if succeeded
/// - false otherwise
/// - \c true if succeeded
/// - \c false otherwise
///
virtual bool GetValue(wxMemoryBuffer &hash);
};
@ -254,8 +254,8 @@ public:
/// Has the key creation been successful?
///
/// \returns
/// - true if creation succeeded
/// - false otherwise
/// - \c true if creation succeeded
/// - \c false otherwise
///
inline bool IsOk() const
{
@ -289,8 +289,8 @@ protected:
/// \param[in] key Public key
///
/// \returns
/// - true if verification succeeded and the hash matches
/// - false otherwise
/// - \c true if verification succeeded and the hash matches
/// - \c false otherwise
///
bool WXEXTEND_API wxCryptoVerifySignature(const wxCryptoHash &hash, const void *signature_data, size_t signature_size, const wxCryptoKey &key);
@ -303,8 +303,8 @@ bool WXEXTEND_API wxCryptoVerifySignature(const wxCryptoHash &hash, const void *
/// \param[in] key Public key
///
/// \returns
/// - true if verification succeeded and the hash matches
/// - false otherwise
/// - \c true if verification succeeded and the hash matches
/// - \c false otherwise
///
inline bool wxCryptoVerifySignature(const wxCryptoHash &hash, const wxMemoryBuffer &signature, const wxCryptoKey &key)
{