WM: comments on wmTooltipState struct
authorCampbell Barton <ideasman42@gmail.com>
Thu, 25 Jan 2018 10:49:31 +0000 (21:49 +1100)
committerCampbell Barton <ideasman42@gmail.com>
Thu, 25 Jan 2018 10:52:40 +0000 (21:52 +1100)
source/blender/windowmanager/WM_types.h

index ded96619a883d0d1ff84708580ed7561494f3c34..0f7d41295f1428af5940c57f0f03ab602c8c2b71 100644 (file)
@@ -690,12 +690,20 @@ typedef struct wmDropBox {
 
 } wmDropBox;
 
+/**
+ * Struct to store tool-tip timer and possible creation if the time is reached.
+ * Allows UI code to call #WM_tooltip_timer_init without each user having to handle the timer.
+ */
 typedef struct wmTooltipState {
+       /** Create tooltip on this event. */
        struct wmTimer *timer;
+       /** The region the tooltip is created in. */
        struct ARegion *region_from;
+       /** The tooltip region. */
        struct ARegion *region;
+       /** Create the tooltip region (assign to 'region'). */
        struct ARegion *(*init)(struct bContext *, struct ARegion *, bool *r_exit_on_event);
-       /* Exit on any event, not needed for buttons since their highlight state is used. */
+       /** Exit on any event, not needed for buttons since their highlight state is used. */
        bool exit_on_event;
 } wmTooltipState;