[Bf-blender-cvs] [2d46ea52cdd] master: WM: comments on wmTooltipState struct

[Campbell Barton]

Commit: 2d46ea52cdd69f929ad7efe8e482cfc0a16de35f
Author: Campbell Barton
Date:   Thu Jan 25 21:49:31 2018 +1100
Branches: master
https://developer.blender.org/rB2d46ea52cdd69f929ad7efe8e482cfc0a16de35f

WM: comments on wmTooltipState struct

===================================================================

M	source/blender/windowmanager/WM_types.h

===================================================================

diff --git a/source/blender/windowmanager/WM_types.h b/source/blender/windowmanager/WM_types.h
index ded96619a88..0f7d41295f1 100644
--- a/source/blender/windowmanager/WM_types.h
+++ b/source/blender/windowmanager/WM_types.h
@@ -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;