Mark deprecated methods as such in wxIcon documentation

wxIcon::Set{Depth|Height|Width}() are deprecated (in wxGDIImage, see 26ee45e),
mark them as such in the documentation (should probably be a part of a5aa044a).

Also fix a typo.

Closes https://github.com/wxWidgets/wxWidgets/pull/2331
This commit is contained in:
PB
2021-04-17 10:33:10 +02:00
committed by Vadim Zeitlin
parent bf5235e01c
commit 46867f591c

View File

@@ -182,7 +182,7 @@ public:
Attach a Windows icon handle. Attach a Windows icon handle.
This wxMSW-specific method allows assigning a native Windows @c HICON This wxMSW-specific method allows assigning a native Windows @c HICON
(which must be castes to @c WXHICON opaque handle type) to wxIcon. (which must be cast to @c WXHICON opaque handle type) to wxIcon.
Notice that this means that the @c HICON will be destroyed by wxIcon Notice that this means that the @c HICON will be destroyed by wxIcon
when it is destroyed. when it is destroyed.
@@ -267,6 +267,9 @@ public:
int desiredWidth = -1, int desiredHeight = -1); int desiredWidth = -1, int desiredHeight = -1);
/** /**
@deprecated This function is deprecated since version 3.1.2, dimensions
and depth can only be set at construction time.
Sets the depth member (does not affect the icon data). Sets the depth member (does not affect the icon data).
@param depth @param depth
@@ -275,6 +278,9 @@ public:
void SetDepth(int depth); void SetDepth(int depth);
/** /**
@deprecated This function is deprecated since version 3.1.2, dimensions
and depth can only be set at construction time.
Sets the height member (does not affect the icon data). Sets the height member (does not affect the icon data).
@param height @param height
@@ -283,6 +289,9 @@ public:
void SetHeight(int height); void SetHeight(int height);
/** /**
@deprecated This function is deprecated since version 3.1.2, dimensions
and depth can only be set at construction time.
Sets the width member (does not affect the icon data). Sets the width member (does not affect the icon data).
@param width @param width