use singular when documenting group of functions as the docs are automatically distri...

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

diff --git a/interface/wx/window.h b/interface/wx/window.h
index c0503b5ee3ed0669a5ef166f008c664a909e2117..8323298572b355724f69ed4177cd4f16ec2cec72 100644 (file)
--- a/interface/wx/window.h
+++ b/interface/wx/window.h
@@ -3062,10 +3062,9 @@ protected:
      */
     void SendDestroyEvent();
 
-    //@{
     /**
-        These functions are public in wxEvtHandler but protected in wxWindow
-        because for wxWindows you should always use this function on the
+        This function is public in wxEvtHandler but protected in wxWindow
+        because for wxWindows you should always call ProcessEvent() on the
         pointer returned by GetEventHandler() and not on the wxWindow object
         itself.
 
@@ -3076,8 +3075,16 @@ protected:
         wxWindow object (e.g. casting it to wxEvtHandler) but doing that will
         create subtle bugs when windows with event handlers pushed on them are
         involved.
+
+        This holds also for all other wxEvtHandler functions.
     */
     virtual bool ProcessEvent(wxEvent& event);
+
+    //@{
+    /**
+        See ProcessEvent() for more info about why you shouldn't use this function
+        and the reason for making this function protected in wxWindow.
+    */
     bool SafelyProcessEvent(wxEvent& event);
     virtual void QueueEvent(wxEvent *event);
     virtual void AddPendingEvent(const wxEvent& event);