Minor doc corrections

[wxWidgets.git] / interface / valgen.h

diff --git a/interface/valgen.h b/interface/valgen.h
index 3281bb3626446bfb4a04f0f1cc3734c7bf4ecceb..00ebc56fd421e8219501ccd5decd88a213969aa1 100644 (file)
--- a/interface/valgen.h
+++ b/interface/valgen.h
@@ -10,51 +10,88 @@
     @class wxGenericValidator
     @wxheader{valgen.h}
 
     @class wxGenericValidator
     @wxheader{valgen.h}
 

-    wxGenericValidator performs data transfer (but not validation or filtering) for
-    the following
-    basic controls: wxButton, wxCheckBox, wxListBox, wxStaticText, wxRadioButton,
-    wxRadioBox,
-    wxChoice, wxComboBox, wxGauge, wxSlider, wxScrollBar, wxSpinButton, wxTextCtrl,
-    wxCheckListBox.
-
-    It checks the type of the window and uses an appropriate type for that window.
-    For example,
-    wxButton and wxTextCtrl transfer data to and from a wxString variable;
-    wxListBox uses a
-    wxArrayInt; wxCheckBox uses a bool.
-
-    For more information, please see @ref overview_validatoroverview "Validator
-    overview".
+    wxGenericValidator performs data transfer (but not validation or filtering)
+    for the following basic controls: wxButton, wxCheckBox, wxListBox,
+    wxStaticText, wxRadioButton, wxRadioBox, wxChoice, wxComboBox, wxGauge,
+    wxSlider, wxScrollBar, wxSpinButton, wxTextCtrl, wxCheckListBox.
+
+    It checks the type of the window and uses an appropriate type for that
+    window. For example, wxButton and wxTextCtrl transfer data to and from a
+    wxString variable; wxListBox uses a wxArrayInt; wxCheckBox uses a bool.
+
+    For more information, please see @ref overview_validator.

 
     @library{wxcore}
     @category{validator}
 
 
     @library{wxcore}
     @category{validator}
 

-    @see @ref overview_validatoroverview "Validator overview", wxValidator,
-    wxTextValidator
+    @see @ref overview_validator, wxValidator, wxTextValidator

 */
 class wxGenericValidator : public wxValidator
 {
 public:
 */
 class wxGenericValidator : public wxValidator
 {
 public:

-    //@{

     /**
     /**

-        Constructor taking a wxDateTime pointer. This will be
-        used for wxDatePickerCtrl.
-        
+        Copy constructor.
+

         @param validator
             Validator to copy.
         @param validator
             Validator to copy.

+    */
+    wxGenericValidator(const wxGenericValidator& validator);
+    /**
+        Constructor taking a bool pointer. This will be used for wxCheckBox,
+        wxRadioButton, wxToggleButton and wxBitmapToggleButton.
+

         @param valPtr
             A pointer to a variable that contains the value. This variable
         @param valPtr
             A pointer to a variable that contains the value. This variable

-            should have a lifetime equal to or longer than the validator lifetime
-        (which is usually
-            determined by the lifetime of the window).
+            should have a lifetime equal to or longer than the validator
+            lifetime (which is usually determined by the lifetime of the
+            window).

     */
     */

-    wxGenericValidator(const wxGenericValidator& validator);

     wxGenericValidator(bool* valPtr);
     wxGenericValidator(bool* valPtr);

+    /**
+        Constructor taking a wxString pointer. This will be used for wxButton,
+        wxComboBox, wxStaticText, wxTextCtrl.
+
+        @param valPtr
+            A pointer to a variable that contains the value. This variable
+            should have a lifetime equal to or longer than the validator
+            lifetime (which is usually determined by the lifetime of the
+            window).
+    */

     wxGenericValidator(wxString* valPtr);
     wxGenericValidator(wxString* valPtr);

+    /**
+        Constructor taking an integer pointer. This will be used for wxChoice,
+        wxGauge, wxScrollBar, wxRadioBox, wxSlider, wxSpinButton and
+        wxSpinCtrl.
+
+        @param valPtr
+            A pointer to a variable that contains the value. This variable
+            should have a lifetime equal to or longer than the validator
+            lifetime (which is usually determined by the lifetime of the
+            window).
+    */

     wxGenericValidator(int* valPtr);
     wxGenericValidator(int* valPtr);

+    /**
+        Constructor taking a wxArrayInt pointer. This will be used for
+        wxListBox, wxCheckListBox.
+
+        @param valPtr
+            A pointer to a variable that contains the value. This variable
+            should have a lifetime equal to or longer than the validator
+            lifetime (which is usually determined by the lifetime of the
+            window).
+    */

     wxGenericValidator(wxArrayInt* valPtr);
     wxGenericValidator(wxArrayInt* valPtr);

+    /**
+        Constructor taking a wxDateTime pointer. This will be used for
+        wxDatePickerCtrl.
+
+        @param valPtr
+            A pointer to a variable that contains the value. This variable
+            should have a lifetime equal to or longer than the validator
+            lifetime (which is usually determined by the lifetime of the
+            window).
+    */

     wxGenericValidator(wxDateTime* valPtr);
     wxGenericValidator(wxDateTime* valPtr);

-    //@}

 
     /**
         Destructor.
 
     /**
         Destructor.