diff options
author | Thomas Gleixner <tglx@linutronix.de> | 2008-10-20 10:38:19 -0400 |
---|---|---|
committer | Thomas Gleixner <tglx@linutronix.de> | 2008-10-20 10:38:19 -0400 |
commit | 592aa999d6a272856c9bfbdaac0cfba1bb37c24c (patch) | |
tree | 8588afce86943b515e96707ee21fed51427b1ccc | |
parent | 643bdf68f92a8516574ed7ca3713f9334c331b8d (diff) |
hrtimers: add missing docbook comments to struct hrtimer
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
-rw-r--r-- | include/linux/hrtimer.h | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/include/linux/hrtimer.h b/include/linux/hrtimer.h index cb25c1cc2352..58bca8e9bae1 100644 --- a/include/linux/hrtimer.h +++ b/include/linux/hrtimer.h | |||
@@ -103,9 +103,14 @@ enum hrtimer_cb_mode { | |||
103 | /** | 103 | /** |
104 | * struct hrtimer - the basic hrtimer structure | 104 | * struct hrtimer - the basic hrtimer structure |
105 | * @node: red black tree node for time ordered insertion | 105 | * @node: red black tree node for time ordered insertion |
106 | * @expires: the absolute expiry time in the hrtimers internal | 106 | * @_expires: the absolute expiry time in the hrtimers internal |
107 | * representation. The time is related to the clock on | 107 | * representation. The time is related to the clock on |
108 | * which the timer is based. | 108 | * which the timer is based. Is setup by adding |
109 | * slack to the _softexpires value. For non range timers | ||
110 | * identical to _softexpires. | ||
111 | * @_softexpires: the absolute earliest expiry time of the hrtimer. | ||
112 | * The time which was given as expiry time when the timer | ||
113 | * was armed. | ||
109 | * @function: timer expiry callback function | 114 | * @function: timer expiry callback function |
110 | * @base: pointer to the timer base (per cpu and per clock) | 115 | * @base: pointer to the timer base (per cpu and per clock) |
111 | * @state: state information (See bit values above) | 116 | * @state: state information (See bit values above) |