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

diff --git a/interface/wx/image.h b/interface/wx/image.h
index 08911e6edfba9b56114631ebadb336c2cca2c578..9982ee2044e94af25147e755183e3ced5882ddea 100644 (file)
--- 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.
     */