More interface header reviews by Azriel Fasten, and added skeleton docs for wxBookCtr...

[wxWidgets.git] / interface / scrolbar.h

diff --git a/interface/scrolbar.h b/interface/scrolbar.h
index 4ea95c9ad3e6617f900b0245787cb4a9e99b3fc5..6f097a8a987b7b0bb84da680a63b432ca078eca3 100644 (file)
--- a/interface/scrolbar.h
+++ b/interface/scrolbar.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        scrolbar.h
-// Purpose:     documentation for wxScrollBar class
+// Purpose:     interface of wxScrollBar
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -16,19 +16,17 @@
     events are received.
 
     @beginStyleTable
-    @style{wxSB_HORIZONTAL}:
+    @style{wxSB_HORIZONTAL}
            Specifies a horizontal scrollbar.
-    @style{wxSB_VERTICAL}:
+    @style{wxSB_VERTICAL}
            Specifies a vertical scrollbar.
     @endStyleTable
 
     @library{wxcore}
     @category{ctrl}
-    @appearance{scrollbar.png}
+    <!-- @appearance{scrollbar.png} -->
 
-    @seealso
-    @ref overview_scrollingoverview "Scrolling overview", @ref
-    overview_eventhandlingoverview, wxScrolledWindow
+    @see @ref overview_scrolling, @ref overview_eventhandling, wxScrolled
 */
 class wxScrollBar : public wxControl
 {
@@ -36,7 +34,7 @@ public:
     //@{
     /**
         Constructor, creating and showing a scrollbar.
-        
+
         @param parent
             Parent window. Must be non-@NULL.
         @param id
@@ -53,7 +51,7 @@ public:
             Window validator.
         @param name
             Window name.
-        
+
         @see Create(), wxValidator
     */
     wxScrollBar();
@@ -85,35 +83,35 @@ public:
         Returns the page size of the scrollbar. This is the number of scroll units
         that will be scrolled when the user pages up or down. Often it is the
         same as the thumb size.
-        
+
         @see SetScrollbar()
     */
     int GetPageSize() const;
 
     /**
         Returns the length of the scrollbar.
-        
+
         @see SetScrollbar()
     */
     int GetRange() const;
 
     /**
         Returns the current position of the scrollbar thumb.
-        
+
         @see SetThumbPosition()
     */
     int GetThumbPosition() const;
 
     /**
         Returns the thumb or 'view' size.
-        
+
         @see SetScrollbar()
     */
     int GetThumbSize() const;
 
     /**
         Sets the scrollbar properties.
-        
+
         @param position
             The position of the scrollbar in scroll units.
         @param thumbSize
@@ -127,7 +125,7 @@ public:
             the thumb size.
         @param refresh
             @true to redraw the scrollbar, @false otherwise.
-        
+
         @remarks Let's say you wish to display 50 lines of text, using the same
                  font. The window is sized so that you can only see 16
                  lines at a time.
@@ -138,11 +136,12 @@ public:
 
     /**
         Sets the position of the scrollbar.
-        
+
         @param viewStart
             The position of the scrollbar thumb.
-        
+
         @see GetThumbPosition()
     */
     void SetThumbPosition(int viewStart);
 };
+