fix various Doxygen errors (#9568)

[wxWidgets.git] / interface / srchctrl.h

diff --git a/interface/srchctrl.h b/interface/srchctrl.h
index a41c566cf27e5244e8119e94c5f6b27e28d29d8a..348632ae3fc6439209f9d94d1cb4956252a6c839 100644 (file)
--- a/interface/srchctrl.h
+++ b/interface/srchctrl.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        srchctrl.h
-// Purpose:     documentation for wxSearchCtrl class
+// Purpose:     interface of wxSearchCtrl
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -14,28 +14,28 @@
     control, and a cancel button.
 
     @beginStyleTable
-    @style{wxTE_PROCESS_ENTER}:
+    @style{wxTE_PROCESS_ENTER}
            The control will generate the event wxEVT_COMMAND_TEXT_ENTER
            (otherwise pressing Enter key is either processed internally by the
            control or used for navigation between dialog controls).
-    @style{wxTE_PROCESS_TAB}:
+    @style{wxTE_PROCESS_TAB}
            The control will receive wxEVT_CHAR events for TAB pressed -
            normally, TAB is used for passing to the next control in a dialog
            instead. For the control created with this style, you can still use
            Ctrl-Enter to pass to the next control from the keyboard.
-    @style{wxTE_NOHIDESEL}:
+    @style{wxTE_NOHIDESEL}
            By default, the Windows text control doesn't show the selection
            when it doesn't have focus - use this style to force it to always
            show it. It doesn't do anything under other platforms.
-    @style{wxTE_LEFT}:
+    @style{wxTE_LEFT}
            The text in the control will be left-justified (default).
-    @style{wxTE_CENTRE}:
+    @style{wxTE_CENTRE}
            The text in the control will be centered (currently wxMSW and
            wxGTK2 only).
-    @style{wxTE_RIGHT}:
+    @style{wxTE_RIGHT}
            The text in the control will be right-justified (currently wxMSW
            and wxGTK2 only).
-    @style{wxTE_CAPITALIZE}:
+    @style{wxTE_CAPITALIZE}
            On PocketPC and Smartphone, causes the first letter to be
            capitalized.
     @endStyleTable
@@ -43,43 +43,38 @@
     @library{wxcore}
     @category{FIXME}
 
-    @seealso
-    wxTextCtrl::Create, wxValidator
+    @see wxTextCtrl::Create, wxValidator
 */
 class wxSearchCtrl : public wxTextCtrl
 {
 public:
-    //@{
+    /**
+      Default constructor
+    */
+    wxSearchCtrl();
+    
     /**
         Constructor, creating and showing a text 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 value
-        Default text value.
-        
+            Default text value.
         @param pos
-        Text control position.
-        
+            Text control position.
         @param size
-        Text control size.
-        
+            Text control size.
         @param style
-        Window style. See wxSearchCtrl.
-        
+            Window style. See wxSearchCtrl.
         @param validator
-        Window validator.
-        
+            Window validator.
         @param name
-        Window name.
-        
-        @sa wxTextCtrl::Create, wxValidator
+            Window name.
+
+        @see wxTextCtrl::Create, wxValidator
     */
-    wxSearchCtrl();
     wxSearchCtrl(wxWindow* parent, wxWindowID id,
                  const wxString& value = "",
                  const wxPoint& pos = wxDefaultPosition,
@@ -87,7 +82,6 @@ public:
                  long style = 0,
                  const wxValidator& validator = wxDefaultValidator,
                  const wxString& name = wxSearchCtrlNameStr);
-    //@}
 
     /**
         Destructor, destroying the search control.
@@ -105,7 +99,6 @@ public:
         If there is a menu attached, the search button will be visible regardless of
         the search
         button visibility value.
-        
         This always returns @false in Mac OS X v10.3
     */
     virtual bool IsSearchButtonVisible();
@@ -114,9 +107,9 @@ public:
         Sets the search control's menu object.  If there is already a menu associated
         with
         the search control it is deleted.
-        
+
         @param menu
-        Menu to attach to the search control.
+            Menu to attach to the search control.
     */
     virtual void SetMenu(wxMenu* menu);
 
@@ -130,8 +123,8 @@ public:
         If there is a menu attached, the search button will be visible regardless of
         the search
         button visibility value.
-        
         This has no effect in Mac OS X v10.3
     */
     virtual void ShowSearchButton(bool show);
 };
+