fixed confusingly complicated sentence to make sense

[wxWidgets.git] / interface / spinbutt.h

diff --git a/interface/spinbutt.h b/interface/spinbutt.h
index 9f532fb2bd92a93bd14fc8eb1db50e52338e6a9c..054bce9150906dc7cbf141f02927adeaba7af7c1 100644 (file)
--- a/interface/spinbutt.h
+++ b/interface/spinbutt.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        spinbutt.h
-// Purpose:     documentation for wxSpinEvent class
+// Purpose:     interface of wxSpinEvent
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -16,8 +16,7 @@
     @library{wxcore}
     @category{events}
 
-    @seealso
-    wxSpinButton and wxSpinCtrl
+    @see wxSpinButton and wxSpinCtrl
 */
 class wxSpinEvent : public wxNotifyEvent
 {
@@ -30,7 +29,7 @@ public:
     /**
         Retrieve the current spin button or control value.
     */
-    int GetPosition();
+    int GetPosition() const;
 
     /**
         Set the value associated with the event.
@@ -39,6 +38,7 @@ public:
 };
 
 
+
 /**
     @class wxSpinButton
     @wxheader{spinbutt.h}
@@ -49,37 +49,40 @@ public:
     as wxSpinButton is not implemented for all platforms but wxSpinCtrl is as it
     degenerates to a simple wxTextCtrl on such platforms.
 
-    @b NB: the range supported by this control (and wxSpinCtrl) depends on the
+    @note the range supported by this control (and wxSpinCtrl) depends on the
     platform but is at least @c -0x8000 to @c 0x7fff. Under GTK and
     Win32 with sufficiently new version of @c comctrl32.dll (at least 4.71 is
     required, 5.80 is recommended) the full 32 bit range is supported.
 
     @beginStyleTable
-    @style{wxSP_HORIZONTAL}:
+    @style{wxSP_HORIZONTAL}
            Specifies a horizontal spin button (note that this style is not
            supported in wxGTK).
-    @style{wxSP_VERTICAL}:
+    @style{wxSP_VERTICAL}
            Specifies a vertical spin button.
-    @style{wxSP_ARROW_KEYS}:
+    @style{wxSP_ARROW_KEYS}
            The user can use arrow keys to change the value.
-    @style{wxSP_WRAP}:
+    @style{wxSP_WRAP}
            The value wraps at the minimum and maximum.
     @endStyleTable
 
     @library{wxcore}
     @category{ctrl}
-    @appearance{spinbutton.png}
+    <!-- @appearance{spinbutton.png} -->
 
-    @seealso
-    wxSpinCtrl
+    @see wxSpinCtrl
 */
 class wxSpinButton : public wxControl
 {
 public:
-    //@{
+    /**
+        Default constructor.
+    */
+    wxSpinButton();
+    
     /**
         Constructor, creating and showing a spin button.
-        
+
         @param parent
             Parent window. Must not be @NULL.
         @param id
@@ -94,16 +97,14 @@ public:
             Window style. See wxSpinButton.
         @param name
             Window name.
-        
+
         @see Create()
     */
-    wxSpinButton();
     wxSpinButton(wxWindow* parent, wxWindowID id,
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
                  long style = wxSP_HORIZONTAL,
                  const wxString& name = "spinButton");
-    //@}
 
     /**
         Destructor, destroys the spin button control.
@@ -122,42 +123,43 @@ public:
 
     /**
         Returns the maximum permissible value.
-        
+
         @see SetRange()
     */
-    int GetMax();
+    int GetMax() const;
 
     /**
         Returns the minimum permissible value.
-        
+
         @see SetRange()
     */
-    int GetMin();
+    int GetMin() const;
 
     /**
         Returns the current spin button value.
-        
+
         @see SetValue()
     */
-    int GetValue();
+    int GetValue() const;
 
     /**
         Sets the range of the spin button.
-        
+
         @param min
             The minimum value for the spin button.
         @param max
             The maximum value for the spin button.
-        
+
         @see GetMin(), GetMax()
     */
     void SetRange(int min, int max);
 
     /**
         Sets the value of the spin button.
-        
+
         @param value
             The value for the spin button.
     */
     void SetValue(int value);
 };
+