Restored the old Classes by Category page to live side-by-side with the full Classes...

[wxWidgets.git] / interface / tipwin.h

diff --git a/interface/tipwin.h b/interface/tipwin.h
index 75b3fa5dcd0fd8235b029f226ad869ccfffd462d..ef4a08e2a4fcbedbd384a0fd7182efc4fbb2ee7d 100644 (file)
--- a/interface/tipwin.h
+++ b/interface/tipwin.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        tipwin.h
-// Purpose:     documentation for wxTipWindow class
+// Purpose:     interface of wxTipWindow
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -26,43 +26,38 @@ class wxTipWindow : public wxWindow
 public:
     /**
         Constructor. The tip is shown immediately after the window is constructed.
-        
+
         @param parent
-        The parent window, must be non-@NULL
-        
+            The parent window, must be non-@NULL
         @param text
-        The text to show, may contain the new line characters
-        
+            The text to show, may contain the new line characters
         @param maxLength
-        The length of each line, in pixels. Set to a very large
-        value to avoid wrapping lines
-        
+            The length of each line, in pixels. Set to a very large
+            value to avoid wrapping lines
         @param windowPtr
-        Simply passed to
-        SetTipWindowPtr below, please see its
-        documentation for the description of this parameter
-        
+            Simply passed to
+            SetTipWindowPtr below, please see its
+            documentation for the description of this parameter
         @param rectBounds
-        If non-@NULL, passed to
-        SetBoundingRect below, please see its
-        documentation for the description of this parameter
+            If non-@NULL, passed to
+            SetBoundingRect below, please see its
+            documentation for the description of this parameter
     */
     wxTipWindow(wxWindow* parent, const wxString& text,
                 wxCoord maxLength = 100,
-                wxTipWindow** windowPtr,
-                wxRect * rectBounds = @NULL);
+                wxTipWindow** windowPtr = NULL,
+                wxRect* rectBounds = NULL);
 
     /**
         By default, the tip window disappears when the user clicks the mouse or presses
         a keyboard key or if it loses focus in any other way - for example because the
         user switched to another application window.
-        
-        Additionally, if a non-empty @e rectBound is provided, the tip window will
+        Additionally, if a non-empty @a rectBound is provided, the tip window will
         also automatically close if the mouse leaves this area. This is useful to
         dismiss the tip mouse when the mouse leaves the object it is associated with.
-        
+
         @param rectBound
-        The bounding rectangle for the mouse in the screen coordinates
+            The bounding rectangle for the mouse in the screen coordinates
     */
     void SetBoundingRect(const wxRect& rectBound);
 
@@ -74,3 +69,4 @@ public:
     */
     void SetTipWindowPtr(wxTipWindow** windowPtr);
 };
+