From d455444a8b6497fda02978cf14528c9e3b2ab102 Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Fri, 27 Feb 2009 14:48:27 +0000 Subject: [PATCH] fix doxygen warnings git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59188 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/event.h | 25 ++++++++++++++++--------- interface/wx/grid.h | 4 ++-- 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/interface/wx/event.h b/interface/wx/event.h index 0be6ec0a8e..d0ea624e1f 100644 --- a/interface/wx/event.h +++ b/interface/wx/event.h @@ -3683,9 +3683,8 @@ wxEventType wxNewEventType(); */ #define wxEVENT_HANDLER_CAST(functype, func) (&func) -//@{ /** - These macros are used to define event table macros for handling custom + This macro is used to define event table macros for handling custom events. Example of use: @@ -3713,20 +3712,28 @@ wxEventType wxNewEventType(); The event type to handle. @param id The identifier of events to handle. - @param id1 - The first identifier of the range. - @param id2 - The second identifier of the range. @param fn The event handler method. */ -#define wx__DECLARE_EVT2(evt, id1, id2, fn) \ - DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL), #define wx__DECLARE_EVT1(evt, id, fn) \ wx__DECLARE_EVT2(evt, id, wxID_ANY, fn) + +/** + Generalized version of the wx__DECLARE_EVT1() macro taking a range of + IDs instead of a single one. + Argument @a id1 is the first identifier of the range, @a id2 is the + second identifier of the range. +*/ +#define wx__DECLARE_EVT2(evt, id1, id2, fn) \ + DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL), + +/** + Simplified version of the wx__DECLARE_EVT1() macro, to be used when the + event type must be handled regardless of the ID associated with the + specific event instances. +*/ #define wx__DECLARE_EVT0(evt, fn) \ wx__DECLARE_EVT1(evt, wxID_ANY, fn) -//@} /** diff --git a/interface/wx/grid.h b/interface/wx/grid.h index cd91eae178..f6b9ef2ff0 100644 --- a/interface/wx/grid.h +++ b/interface/wx/grid.h @@ -1032,7 +1032,7 @@ public: @class wxGridSizesInfo wxGridSizesInfo stores information about sizes of all wxGrid rows or - columns. + columns. It assumes that most of the rows or columns (which are both called elements here as the difference between them doesn't matter at this class level) @@ -1062,7 +1062,7 @@ struct wxGridSizesInfo @param defSize The default element size. - @param + @param allSizes Array containing the sizes of @em all elements, including those which have the default size. */