use singular when documenting group of functions as the docs are automatically distributed by Doxygen over all members of the group

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58484 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2009-01-28 17:30:57 +00:00
parent befa206be9
commit 4fde860eb3

View File

@@ -3062,10 +3062,9 @@ protected:
*/ */
void SendDestroyEvent(); void SendDestroyEvent();
//@{
/** /**
These functions are public in wxEvtHandler but protected in wxWindow This function is public in wxEvtHandler but protected in wxWindow
because for wxWindows you should always use this function on the because for wxWindows you should always call ProcessEvent() on the
pointer returned by GetEventHandler() and not on the wxWindow object pointer returned by GetEventHandler() and not on the wxWindow object
itself. itself.
@@ -3076,8 +3075,16 @@ protected:
wxWindow object (e.g. casting it to wxEvtHandler) but doing that will wxWindow object (e.g. casting it to wxEvtHandler) but doing that will
create subtle bugs when windows with event handlers pushed on them are create subtle bugs when windows with event handlers pushed on them are
involved. involved.
This holds also for all other wxEvtHandler functions.
*/ */
virtual bool ProcessEvent(wxEvent& event); 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); bool SafelyProcessEvent(wxEvent& event);
virtual void QueueEvent(wxEvent *event); virtual void QueueEvent(wxEvent *event);
virtual void AddPendingEvent(const wxEvent& event); virtual void AddPendingEvent(const wxEvent& event);