Intial review of calctrl.h.

[wxWidgets.git] / interface / caret.h

diff --git a/interface/caret.h b/interface/caret.h
index cc9b5aec58794614b24424ee02c9abbecd56f3e7..3b386e6e9a3032193b579ff7f4184301e90e0464 100644 (file)
--- a/interface/caret.h
+++ b/interface/caret.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        caret.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        caret.h

-// Purpose:     documentation for wxCaret class
+// Purpose:     interface of wxCaret

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -24,8 +24,7 @@
     @library{wxcore}
     @category{misc}
 
     @library{wxcore}
     @category{misc}
 

-    @seealso
-    wxCaret::GetBlinkTime
+    @see wxCaret::GetBlinkTime

 */
 class wxCaret
 {
 */
 class wxCaret
 {


@@ -59,13 +58,13 @@ public:
     //@{
     /**
         Get the caret position (in pixels).
     //@{
     /**
         Get the caret position (in pixels).

-        
+

         @b GetPosition()
         @b GetPosition()

-        
+

         Returns a Wx::Point
         Returns a Wx::Point

-        
+

         @b GetPositionXY()
         @b GetPositionXY()

-        
+

         Returns a 2-element list
          @c ( x, y )
     */
         Returns a 2-element list
          @c ( x, y )
     */


@@ -76,13 +75,13 @@ public:
     //@{
     /**
         Get the caret size.
     //@{
     /**
         Get the caret size.

-        
+

         @b GetSize()
         @b GetSize()

-        
+

         Returns a Wx::Size
         Returns a Wx::Size

-        
+

         @b GetSizeWH()
         @b GetSizeWH()

-        
+

         Returns a 2-element list
          @c ( width, height )
     */
         Returns a 2-element list
          @c ( width, height )
     */


@@ -122,11 +121,11 @@ public:
 
     /**
         Sets the blink time for all the carets.
 
     /**
         Sets the blink time for all the carets.

-        
+

         @remarks Under Windows, this function will change the blink time for all
                  carets permanently (until the next time it is called),
                  even for the carets in other applications.
         @remarks Under Windows, this function will change the blink time for all
                  carets permanently (until the next time it is called),
                  even for the carets in other applications.

-        
+

         @see GetBlinkTime()
     */
     static void SetBlinkTime(int milliseconds);
         @see GetBlinkTime()
     */
     static void SetBlinkTime(int milliseconds);


@@ -145,3 +144,4 @@ public:
     */
     void Show(bool show = true);
 };
     */
     void Show(bool show = true);
 };

+