Minor doc corrections for [q-r] in ticket #9581 (most of the patch was applied alread...

[wxWidgets.git] / interface / bitmap.h

diff --git a/interface/bitmap.h b/interface/bitmap.h
index 8656ae698357535d7be249e86b4bdcb19224e666..1bcf959e19af98c378fab2c040e562b82ee5b045 100644 (file)
--- a/interface/bitmap.h
+++ b/interface/bitmap.h
@@ -64,7 +64,7 @@ public:
             A bitmap type identifier - see ::wxBitmapType for a list
             of possible values.
 
-        @returns @true if the call succeeded, @false otherwise (the default).
+        @return @true if the call succeeded, @false otherwise (the default).
     */
     virtual bool Create(wxBitmap* bitmap, const void* data, wxBitmapType type,
                         int width, int height, int depth = 1);
@@ -100,7 +100,7 @@ public:
         @param desiredHeight
             The desired height for the loaded bitmap.
 
-        @returns @true if the operation succeeded, @false otherwise.
+        @return @true if the operation succeeded, @false otherwise.
 
         @see wxBitmap::LoadFile, wxBitmap::SaveFile, SaveFile()
     */
@@ -119,7 +119,7 @@ public:
         @param palette
             An optional palette used for saving the bitmap.
 
-        @returns @true if the operation succeeded, @false otherwise.
+        @return @true if the operation succeeded, @false otherwise.
 
         @see wxBitmap::LoadFile, wxBitmap::SaveFile, LoadFile()
     */
@@ -158,6 +158,11 @@ public:
 
     This class encapsulates the concept of a platform-dependent bitmap,
     either monochrome or colour or colour with alpha channel support.
+    
+    If you need direct access the bitmap data instead going through
+    drawing to it using wxMemoryDC you need to use the wxPixelData
+    class (either wxNativePixelData for RGB bitmaps or wxAlphaPixelData
+    for bitmaps with an additionaly alpha channel).
 
     @note
     Many wxBitmap functions take a @e type parameter, which is a value of the
@@ -178,7 +183,7 @@ public:
     ::wxNullBitmap
 
     @see @ref overview_bitmap, @ref overview_bitmap_supportedformats,
-         wxDC::Blit, wxIcon, wxCursor, wxBitmap, wxMemoryDC
+         wxDC::Blit, wxIcon, wxCursor, wxMemoryDC, wxImage, wxPixelData
 */
 class wxBitmap : public wxGDIObject
 {
@@ -371,7 +376,7 @@ public:
         @param depth
             The depth of the bitmap in pixels. If this is -1, the screen depth is used.
 
-        @returns @true if the call succeeded, @false otherwise.
+        @return @true if the call succeeded, @false otherwise.
 
         This overload depends on the @a type of data.
 
@@ -384,7 +389,7 @@ public:
     /**
         Finds the handler with the given @a name.
 
-        @returns A pointer to the handler if found, @NULL otherwise.
+        @return A pointer to the handler if found, @NULL otherwise.
     */
     static wxBitmapHandler* FindHandler(const wxString& name);
 
@@ -396,7 +401,7 @@ public:
         @param bitmapType
             The bitmap type managed by the handler, see ::wxBitmapType.
 
-        @returns A pointer to the handler if found, @NULL otherwise.
+        @return A pointer to the handler if found, @NULL otherwise.
     */
     static wxBitmapHandler* FindHandler(const wxString& extension,
                                         wxBitmapType bitmapType);
@@ -407,7 +412,7 @@ public:
         @param bitmapType
             The bitmap type managed by the handler, see ::wxBitmapType.
 
-        @returns A pointer to the handler if found, @NULL otherwise.
+        @return A pointer to the handler if found, @NULL otherwise.
 
         @see wxBitmapHandler
     */
@@ -498,7 +503,7 @@ public:
             One of the ::wxBitmapType values; see the note in the class
             detailed description.
 
-        @returns @true if the operation succeeded, @false otherwise.
+        @return @true if the operation succeeded, @false otherwise.
 
         @remarks A palette may be associated with the bitmap if one exists
                  (especially for colour Windows bitmaps), and if the
@@ -516,7 +521,7 @@ public:
         @param name
             The handler name.
 
-        @returns @true if the handler was found and removed, @false otherwise.
+        @return @true if the handler was found and removed, @false otherwise.
 
         @see wxBitmapHandler
     */
@@ -533,7 +538,7 @@ public:
         @param palette
             An optional palette used for saving the bitmap.
 
-        @returns @true if the operation succeeded, @false otherwise.
+        @return @true if the operation succeeded, @false otherwise.
 
         @remarks Depending on how wxWidgets has been configured, not all formats
                  may be available.