fix various Doxygen errors (#9568)

[wxWidgets.git] / interface / statbmp.h

diff --git a/interface/statbmp.h b/interface/statbmp.h
index c5cb6b3bbae928548dc4265b0f24cd132e5f03bc..dde41369503a09b30d0203393ba50d678409232d 100644 (file)
--- a/interface/statbmp.h
+++ b/interface/statbmp.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        statbmp.h
-// Purpose:     documentation for wxStaticBitmap class
+// Purpose:     interface of wxStaticBitmap
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -18,49 +18,44 @@
 
     @library{wxcore}
     @category{ctrl}
-    @appearance{staticbitmap.png}
+    <!-- @appearance{staticbitmap.png} -->
 
-    @seealso
-    wxStaticBitmap, wxStaticBox
+    @see wxStaticBitmap, wxStaticBox
 */
 class wxStaticBitmap : public wxControl
 {
 public:
-    //@{
+    /**
+      Default constructor
+    */
+    wxStaticBitmap();
+    
     /**
         Constructor, creating and showing a static bitmap control.
-        
+
         @param parent
-        Parent window. Should not be @NULL.
-        
+            Parent window. Should not be @NULL.
         @param id
-        Control identifier. A value of -1 denotes a default value.
-        
+            Control identifier. A value of -1 denotes a default value.
         @param label
-        Bitmap label.
-        
+            Bitmap label.
         @param pos
-        Window position.
-        
+            Window position.
         @param size
-        Window size.
-        
+            Window size.
         @param style
-        Window style. See wxStaticBitmap.
-        
+            Window style. See wxStaticBitmap.
         @param name
-        Window name.
-        
-        @sa Create()
+            Window name.
+
+        @see Create()
     */
-    wxStaticBitmap();
     wxStaticBitmap(wxWindow* parent, wxWindowID id,
                    const wxBitmap& label,
                    const wxPoint& pos = wxDefaultPosition,
                    const wxSize& size = wxDefaultSize,
                    long style = 0,
                    const wxString& name = "staticBitmap");
-    //@}
 
     /**
         Creation function, for two-step construction. For details see wxStaticBitmap().
@@ -75,36 +70,37 @@ public:
     /**
         Returns the bitmap currently used in the control. Notice that this method can
         be called even if SetIcon() had been used.
-        
-        @sa SetBitmap()
+
+        @see SetBitmap()
     */
-    wxBitmap GetBitmap();
+    wxBitmap GetBitmap() const;
 
     /**
         Returns the icon currently used in the control. Notice that this method can
         only be called if SetIcon() had been used: an icon
         can't be retrieved from the control if a bitmap had been set (using
         wxStaticBitmap::SetBitmap).
-        
-        @sa SetIcon()
+
+        @see SetIcon()
     */
-    wxIcon GetIcon();
+    wxIcon GetIcon() const;
 
     /**
         Sets the bitmap label.
-        
+
         @param label
-        The new bitmap.
-        
-        @sa GetBitmap()
+            The new bitmap.
+
+        @see GetBitmap()
     */
     virtual void SetBitmap(const wxBitmap& label);
 
     /**
         Sets the label to the given icon.
-        
+
         @param label
-        The new icon.
+            The new icon.
     */
     virtual void SetIcon(const wxIcon& label);
 };
+