Document struct wxPGPaintData in function docs of only function that uses it

[wxWidgets.git] / interface / wx / propgrid / property.h

diff --git a/interface/wx/propgrid/property.h b/interface/wx/propgrid/property.h
index 81ac31dbe6cbfb142b6e366e030aafc596644e72..4161eb19f36b62c73cb5aa4aaf1ad6fadb896343 100644 (file)
--- a/interface/wx/propgrid/property.h
+++ b/interface/wx/propgrid/property.h
@@ -10,26 +10,6 @@
 #define wxNullProperty  ((wxPGProperty*)NULL)
 
 
 #define wxNullProperty  ((wxPGProperty*)NULL)
 
 

-/** wxPGPaintData
-
-    Contains information relayed to property's OnCustomPaint.
-*/
-struct wxPGPaintData
-{
-    /** wxPropertyGrid. */
-    const wxPropertyGrid*   m_parent;
-
-    /** Normally -1, otherwise index to drop-down list item that has to be drawn. */
-    int                     m_choiceItem;
-
-    /** Set to drawn width in OnCustomPaint (optional). */
-    int                     m_drawnWidth;
-
-    /** In a measure item call, set this to the height of item at m_choiceItem index. */
-    int                     m_drawnHeight;   
-};
-
-

 // Structure for relaying choice/list info.
 struct wxPGChoiceInfo
 {
 // Structure for relaying choice/list info.
 struct wxPGChoiceInfo
 {


@@ -693,7 +673,23 @@ public:
         Box reserved for custom graphics. Includes surrounding rectangle, if any.
         If x is < 0, then this is a measure item call (see above).
         @param paintdata
         Box reserved for custom graphics. Includes surrounding rectangle, if any.
         If x is < 0, then this is a measure item call (see above).
         @param paintdata

-        wxPGPaintData structure with much useful data.
+        wxPGPaintData structure with much useful data about painted item.
+        @code
+        struct wxPGPaintData
+        {
+            // wxPropertyGrid.
+            const wxPropertyGrid*   m_parent;
+
+            // Normally -1, otherwise index to drop-down list item that has to be drawn.
+            int                     m_choiceItem;
+
+            // Set to drawn width in OnCustomPaint (optional).
+            int                     m_drawnWidth;
+
+            // In a measure item call, set this to the height of item at m_choiceItem index
+            int                     m_drawnHeight;   
+        };
+        @endcode

 
         @remarks
             - You can actually exceed rect width, but if you do so then paintdata.m_drawnWidth
 
         @remarks
             - You can actually exceed rect width, but if you do so then paintdata.m_drawnWidth