diff options
| author | Randy Dunlap <rdunlap@xenotime.net> | 2006-06-25 08:49:15 -0400 |
|---|---|---|
| committer | Linus Torvalds <torvalds@g5.osdl.org> | 2006-06-25 13:01:23 -0400 |
| commit | fa9799e33d362aeca4555cd6318735bab1c04d16 (patch) | |
| tree | 3fbef83fe505f34950f4b30fb4158e2e599ce92f /include/linux | |
| parent | 9dc65576d67dc45e529062e41ca34066e02f03e5 (diff) | |
[PATCH] ktime/hrtimer: fix kernel-doc comments
Fix kernel-doc formatting in ktime.h and hrtimer.[ch] files.
Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Diffstat (limited to 'include/linux')
| -rw-r--r-- | include/linux/hrtimer.h | 3 | ||||
| -rw-r--r-- | include/linux/ktime.h | 8 |
2 files changed, 0 insertions, 11 deletions
diff --git a/include/linux/hrtimer.h b/include/linux/hrtimer.h index 7d2a1b974c..07d7305f13 100644 --- a/include/linux/hrtimer.h +++ b/include/linux/hrtimer.h | |||
| @@ -40,7 +40,6 @@ struct hrtimer_base; | |||
| 40 | 40 | ||
| 41 | /** | 41 | /** |
| 42 | * struct hrtimer - the basic hrtimer structure | 42 | * struct hrtimer - the basic hrtimer structure |
| 43 | * | ||
| 44 | * @node: red black tree node for time ordered insertion | 43 | * @node: red black tree node for time ordered insertion |
| 45 | * @expires: the absolute expiry time in the hrtimers internal | 44 | * @expires: the absolute expiry time in the hrtimers internal |
| 46 | * representation. The time is related to the clock on | 45 | * representation. The time is related to the clock on |
| @@ -59,7 +58,6 @@ struct hrtimer { | |||
| 59 | 58 | ||
| 60 | /** | 59 | /** |
| 61 | * struct hrtimer_sleeper - simple sleeper structure | 60 | * struct hrtimer_sleeper - simple sleeper structure |
| 62 | * | ||
| 63 | * @timer: embedded timer structure | 61 | * @timer: embedded timer structure |
| 64 | * @task: task to wake up | 62 | * @task: task to wake up |
| 65 | * | 63 | * |
| @@ -72,7 +70,6 @@ struct hrtimer_sleeper { | |||
| 72 | 70 | ||
| 73 | /** | 71 | /** |
| 74 | * struct hrtimer_base - the timer base for a specific clock | 72 | * struct hrtimer_base - the timer base for a specific clock |
| 75 | * | ||
| 76 | * @index: clock type index for per_cpu support when moving a timer | 73 | * @index: clock type index for per_cpu support when moving a timer |
| 77 | * to a base on another cpu. | 74 | * to a base on another cpu. |
| 78 | * @lock: lock protecting the base and associated timers | 75 | * @lock: lock protecting the base and associated timers |
diff --git a/include/linux/ktime.h b/include/linux/ktime.h index 62bc575807..ed3396dcc4 100644 --- a/include/linux/ktime.h +++ b/include/linux/ktime.h | |||
| @@ -66,7 +66,6 @@ typedef union { | |||
| 66 | 66 | ||
| 67 | /** | 67 | /** |
| 68 | * ktime_set - Set a ktime_t variable from a seconds/nanoseconds value | 68 | * ktime_set - Set a ktime_t variable from a seconds/nanoseconds value |
| 69 | * | ||
| 70 | * @secs: seconds to set | 69 | * @secs: seconds to set |
| 71 | * @nsecs: nanoseconds to set | 70 | * @nsecs: nanoseconds to set |
| 72 | * | 71 | * |
| @@ -138,7 +137,6 @@ static inline ktime_t ktime_set(const long secs, const unsigned long nsecs) | |||
| 138 | 137 | ||
| 139 | /** | 138 | /** |
| 140 | * ktime_sub - subtract two ktime_t variables | 139 | * ktime_sub - subtract two ktime_t variables |
| 141 | * | ||
| 142 | * @lhs: minuend | 140 | * @lhs: minuend |
| 143 | * @rhs: subtrahend | 141 | * @rhs: subtrahend |
| 144 | * | 142 | * |
| @@ -157,7 +155,6 @@ static inline ktime_t ktime_sub(const ktime_t lhs, const ktime_t rhs) | |||
| 157 | 155 | ||
| 158 | /** | 156 | /** |
| 159 | * ktime_add - add two ktime_t variables | 157 | * ktime_add - add two ktime_t variables |
| 160 | * | ||
| 161 | * @add1: addend1 | 158 | * @add1: addend1 |
| 162 | * @add2: addend2 | 159 | * @add2: addend2 |
| 163 | * | 160 | * |
| @@ -184,7 +181,6 @@ static inline ktime_t ktime_add(const ktime_t add1, const ktime_t add2) | |||
| 184 | 181 | ||
| 185 | /** | 182 | /** |
| 186 | * ktime_add_ns - Add a scalar nanoseconds value to a ktime_t variable | 183 | * ktime_add_ns - Add a scalar nanoseconds value to a ktime_t variable |
| 187 | * | ||
| 188 | * @kt: addend | 184 | * @kt: addend |
| 189 | * @nsec: the scalar nsec value to add | 185 | * @nsec: the scalar nsec value to add |
| 190 | * | 186 | * |
| @@ -194,7 +190,6 @@ extern ktime_t ktime_add_ns(const ktime_t kt, u64 nsec); | |||
| 194 | 190 | ||
| 195 | /** | 191 | /** |
| 196 | * timespec_to_ktime - convert a timespec to ktime_t format | 192 | * timespec_to_ktime - convert a timespec to ktime_t format |
| 197 | * | ||
| 198 | * @ts: the timespec variable to convert | 193 | * @ts: the timespec variable to convert |
| 199 | * | 194 | * |
| 200 | * Returns a ktime_t variable with the converted timespec value | 195 | * Returns a ktime_t variable with the converted timespec value |
| @@ -207,7 +202,6 @@ static inline ktime_t timespec_to_ktime(const struct timespec ts) | |||
| 207 | 202 | ||
| 208 | /** | 203 | /** |
| 209 | * timeval_to_ktime - convert a timeval to ktime_t format | 204 | * timeval_to_ktime - convert a timeval to ktime_t format |
| 210 | * | ||
| 211 | * @tv: the timeval variable to convert | 205 | * @tv: the timeval variable to convert |
| 212 | * | 206 | * |
| 213 | * Returns a ktime_t variable with the converted timeval value | 207 | * Returns a ktime_t variable with the converted timeval value |
| @@ -220,7 +214,6 @@ static inline ktime_t timeval_to_ktime(const struct timeval tv) | |||
| 220 | 214 | ||
| 221 | /** | 215 | /** |
| 222 | * ktime_to_timespec - convert a ktime_t variable to timespec format | 216 | * ktime_to_timespec - convert a ktime_t variable to timespec format |
| 223 | * | ||
| 224 | * @kt: the ktime_t variable to convert | 217 | * @kt: the ktime_t variable to convert |
| 225 | * | 218 | * |
| 226 | * Returns the timespec representation of the ktime value | 219 | * Returns the timespec representation of the ktime value |
| @@ -233,7 +226,6 @@ static inline struct timespec ktime_to_timespec(const ktime_t kt) | |||
| 233 | 226 | ||
| 234 | /** | 227 | /** |
| 235 | * ktime_to_timeval - convert a ktime_t variable to timeval format | 228 | * ktime_to_timeval - convert a ktime_t variable to timeval format |
| 236 | * | ||
| 237 | * @kt: the ktime_t variable to convert | 229 | * @kt: the ktime_t variable to convert |
| 238 | * | 230 | * |
| 239 | * Returns the timeval representation of the ktime value | 231 | * Returns the timeval representation of the ktime value |
