Fix Doxygen warnings due to documenting overloaded functions together.

Apparently we can't make @param statements apply just to some overloads, so
document them separately now.

See #15346.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74704 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/event.h b/interface/wx/event.h
index 618d95a8ab2cc501952105d74cc2de0dad8a6056..b80624003d7273981e8bcb4b414b0964f493ca7a 100644 (file)
--- a/interface/wx/event.h
+++ b/interface/wx/event.h
@@ -522,11 +522,9 @@ public:
 
          @param method The method to call.
          @param x1 The (optional) first parameter to pass to the method.
-         @param x2 The (optional) second parameter to pass to the method.
-
-         Note that currently only up to 2 arguments can be passed. For more
-         complicated needs, you can use the CallAfter<T>(const T& fn) overload
-         that can call any functor.
+            Currently, 0, 1 or 2 parameters can be passed. If you need to pass
+            more than 2 arguments, you can use the CallAfter<T>(const T& fn)
+            overload that can call any functor.
 
          @note This method is not available with Visual C++ before version 8
                (Visual Studio 2005) as earlier versions of the compiler don't

diff --git a/interface/wx/textctrl.h b/interface/wx/textctrl.h
index 090e87f247bcb612259a8e47b288c479bdee2be5..cac926f5fedcb0a85442e2aca07fa33890af6579 100644 (file)
--- a/interface/wx/textctrl.h
+++ b/interface/wx/textctrl.h
@@ -1300,14 +1300,34 @@ public:
     */
     virtual bool GetStyle(long position, wxTextAttr& style);
 
-    //@{
     /**
-        This function finds the character at the specified position expressed
-        in pixels.
+        Finds the position of the character at the specified point.
+
+        If the return code is not @c wxTE_HT_UNKNOWN the row and column of the
+        character closest to this position are returned, otherwise the output
+        parameters are not modified.
+
+        Please note that this function is currently only implemented in wxUniv,
+        wxMSW and wxGTK2 ports and always returns @c wxTE_HT_UNKNOWN in the
+        other ports.
+
+        @beginWxPerlOnly
+        In wxPerl this function takes only the @a pt argument and
+        returns a 3-element list (result, col, row).
+        @endWxPerlOnly
+
+        @param pt
+            The position of the point to check, in window device coordinates.
+        @param pos
+            Receives the position of the character at the given position. May
+            be @NULL.
 
-        The two overloads of this method allow to find either the position of
-        the character, as an index into the text control contents, or its row
-        and column.
+        @see PositionToXY(), XYToPosition()
+    */
+    wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
+
+    /**
+        Finds the row and column of the character at the specified point.
 
         If the return code is not @c wxTE_HT_UNKNOWN the row and column of the
         character closest to this position are returned, otherwise the output
@@ -1330,17 +1350,12 @@ public:
         @param row
             Receives the row of the character at the given position. May be
             @NULL.
-        @param pos
-            Receives the position of the character at the given position. May
-            be @NULL.
 
         @see PositionToXY(), XYToPosition()
     */
-    wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
     wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
                                     wxTextCoord *col,
                                     wxTextCoord *row) const;
-    //@}
 
     /**
         Returns @true if the text has been modified by user.

diff --git a/interface/wx/valnum.h b/interface/wx/valnum.h
index 0ca772304cd87ca6415877b7c46c702b7e492676..7f65786821d49544b7808c6591a16895426df2cb 100644 (file)
--- a/interface/wx/valnum.h
+++ b/interface/wx/valnum.h
@@ -305,7 +305,21 @@ public:
     typedef T ValueType;
 
     /**
-        Validator constructor.
+        Constructor for validator using the default precision.
+
+        @param value
+            A pointer to the variable associated with the validator. If non
+            @NULL, this variable should have a lifetime equal to or longer than
+            the validator lifetime (which is usually determined by the lifetime
+            of the window).
+        @param style
+            A combination of wxNumValidatorStyle enum values.
+    */
+    wxFloatingPointValidator(ValueType *value = NULL,
+                             int style = wxNUM_VAL_DEFAULT);
+
+    /**
+        Constructor for validator specifying the precision.
 
         @param value
             A pointer to the variable associated with the validator. If non
@@ -318,13 +332,9 @@ public:
             The number of decimal digits after the decimal separator to show
             and accept.
     */
-    //@{
-    wxFloatingPointValidator(ValueType *value = NULL,
-                             int style = wxNUM_VAL_DEFAULT);
     wxFloatingPointValidator(int precision,
                              ValueType *value = NULL,
                              int style = wxNUM_VAL_DEFAULT);
-    //@}
 
 
     /**