document "clear" parameter of ctor/Create() properly (part of #9639)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54931 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2008-08-02 20:00:50 +00:00
parent 05d31b3aca
commit ff3050e17a

View File

@@ -175,15 +175,16 @@ public:
wxImage(); wxImage();
/** /**
Creates an image with the given size and clears it if requested. Creates an image with the given size and clears it if requested.
Does not create an alpha channel.
Does not create an alpha channel.
@param width @param width
Specifies the width of the image. Specifies the width of the image.
@param height @param height
Specifies the height of the image. Specifies the height of the image.
@clear @param clear
Clear the image with zeros. If @true, initialize the image to black.
*/ */
wxImage(int width, int height, bool clear = true); wxImage(int width, int height, bool clear = true);
@@ -404,14 +405,17 @@ public:
wxImage Copy() const; wxImage Copy() const;
/** /**
Creates a fresh image. If @a clear is @true, the new image will be initialized Creates a fresh image.
to black.
If @a clear is @true, the new image will be initialized to black.
Otherwise, the image data will be uninitialized. Otherwise, the image data will be uninitialized.
@param width @param width
The width of the image in pixels. The width of the image in pixels.
@param height @param height
The height of the image in pixels. The height of the image in pixels.
@param clear
If @true, initialize the image data with zeros.
@return @true if the call succeeded, @false otherwise. @return @true if the call succeeded, @false otherwise.
*/ */