]> git.saurik.com Git - wxWidgets.git/commitdiff
fix doxygen warnings
authorFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Fri, 27 Feb 2009 14:48:27 +0000 (14:48 +0000)
committerFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Fri, 27 Feb 2009 14:48:27 +0000 (14:48 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59188 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/event.h
interface/wx/grid.h

index 0be6ec0a8ecef039c2c58732f9b23dc091b5e91a..d0ea624e1f468b5328eb93b6d7db1b043d2ddcf2 100644 (file)
@@ -3683,9 +3683,8 @@ wxEventType wxNewEventType();
  */
 #define wxEVENT_HANDLER_CAST(functype, func) (&func)
 
  */
 #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:
     events.
 
     Example of use:
@@ -3713,20 +3712,28 @@ wxEventType wxNewEventType();
         The event type to handle.
     @param id
         The identifier of events to handle.
         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.
  */
     @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)
 #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)
 #define wx__DECLARE_EVT0(evt, fn) \
     wx__DECLARE_EVT1(evt, wxID_ANY, fn)
-//@}
 
 
 /**
 
 
 /**
index cd91eae17806e097a37a9aa7dc3c96adc6ce12f7..f6b9ef2ff0a0ea9a45394481a98f848f0fa9c805 100644 (file)
@@ -1032,7 +1032,7 @@ public:
     @class wxGridSizesInfo
 
     wxGridSizesInfo stores information about sizes of all wxGrid rows or
     @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)
 
     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 defSize
             The default element size.
-        @param
+        @param allSizes
             Array containing the sizes of @em all elements, including those
             which have the default size.
      */
             Array containing the sizes of @em all elements, including those
             which have the default size.
      */