From ff3050e17ad4c5fa1c52150d0dc8abc8be3cbe50 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sat, 2 Aug 2008 20:00:50 +0000 Subject: [PATCH] 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 --- interface/wx/image.h | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/interface/wx/image.h b/interface/wx/image.h index 08911e6edf..9982ee2044 100644 --- a/interface/wx/image.h +++ b/interface/wx/image.h @@ -175,15 +175,16 @@ public: wxImage(); /** - Creates an image with the given size and clears it if requested. - Does not create an alpha channel. + Creates an image with the given size and clears it if requested. + + Does not create an alpha channel. @param width Specifies the width of the image. @param height Specifies the height of the image. - @clear - Clear the image with zeros. + @param clear + If @true, initialize the image to black. */ wxImage(int width, int height, bool clear = true); @@ -404,14 +405,17 @@ public: wxImage Copy() const; /** - Creates a fresh image. If @a clear is @true, the new image will be initialized - to black. + Creates a fresh image. + + If @a clear is @true, the new image will be initialized to black. Otherwise, the image data will be uninitialized. @param width The width of the image in pixels. @param height 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. */ -- 2.45.2