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 | |
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>
-rw-r--r-- | include/linux/hrtimer.h | 3 | ||||
-rw-r--r-- | include/linux/ktime.h | 8 | ||||
-rw-r--r-- | kernel/hrtimer.c | 11 |
3 files changed, 1 insertions, 21 deletions
diff --git a/include/linux/hrtimer.h b/include/linux/hrtimer.h index 7d2a1b974c5e..07d7305f131e 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 62bc57580707..ed3396dcc4f7 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 |
diff --git a/kernel/hrtimer.c b/kernel/hrtimer.c index 9587aac72f4d..55601b3ce60e 100644 --- a/kernel/hrtimer.c +++ b/kernel/hrtimer.c | |||
@@ -98,7 +98,6 @@ static DEFINE_PER_CPU(struct hrtimer_base, hrtimer_bases[MAX_HRTIMER_BASES]) = | |||
98 | 98 | ||
99 | /** | 99 | /** |
100 | * ktime_get_ts - get the monotonic clock in timespec format | 100 | * ktime_get_ts - get the monotonic clock in timespec format |
101 | * | ||
102 | * @ts: pointer to timespec variable | 101 | * @ts: pointer to timespec variable |
103 | * | 102 | * |
104 | * The function calculates the monotonic clock from the realtime | 103 | * The function calculates the monotonic clock from the realtime |
@@ -238,7 +237,6 @@ lock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags) | |||
238 | # ifndef CONFIG_KTIME_SCALAR | 237 | # ifndef CONFIG_KTIME_SCALAR |
239 | /** | 238 | /** |
240 | * ktime_add_ns - Add a scalar nanoseconds value to a ktime_t variable | 239 | * ktime_add_ns - Add a scalar nanoseconds value to a ktime_t variable |
241 | * | ||
242 | * @kt: addend | 240 | * @kt: addend |
243 | * @nsec: the scalar nsec value to add | 241 | * @nsec: the scalar nsec value to add |
244 | * | 242 | * |
@@ -299,7 +297,6 @@ void unlock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags) | |||
299 | 297 | ||
300 | /** | 298 | /** |
301 | * hrtimer_forward - forward the timer expiry | 299 | * hrtimer_forward - forward the timer expiry |
302 | * | ||
303 | * @timer: hrtimer to forward | 300 | * @timer: hrtimer to forward |
304 | * @now: forward past this time | 301 | * @now: forward past this time |
305 | * @interval: the interval to forward | 302 | * @interval: the interval to forward |
@@ -411,7 +408,6 @@ remove_hrtimer(struct hrtimer *timer, struct hrtimer_base *base) | |||
411 | 408 | ||
412 | /** | 409 | /** |
413 | * hrtimer_start - (re)start an relative timer on the current CPU | 410 | * hrtimer_start - (re)start an relative timer on the current CPU |
414 | * | ||
415 | * @timer: the timer to be added | 411 | * @timer: the timer to be added |
416 | * @tim: expiry time | 412 | * @tim: expiry time |
417 | * @mode: expiry mode: absolute (HRTIMER_ABS) or relative (HRTIMER_REL) | 413 | * @mode: expiry mode: absolute (HRTIMER_ABS) or relative (HRTIMER_REL) |
@@ -460,14 +456,13 @@ EXPORT_SYMBOL_GPL(hrtimer_start); | |||
460 | 456 | ||
461 | /** | 457 | /** |
462 | * hrtimer_try_to_cancel - try to deactivate a timer | 458 | * hrtimer_try_to_cancel - try to deactivate a timer |
463 | * | ||
464 | * @timer: hrtimer to stop | 459 | * @timer: hrtimer to stop |
465 | * | 460 | * |
466 | * Returns: | 461 | * Returns: |
467 | * 0 when the timer was not active | 462 | * 0 when the timer was not active |
468 | * 1 when the timer was active | 463 | * 1 when the timer was active |
469 | * -1 when the timer is currently excuting the callback function and | 464 | * -1 when the timer is currently excuting the callback function and |
470 | * can not be stopped | 465 | * cannot be stopped |
471 | */ | 466 | */ |
472 | int hrtimer_try_to_cancel(struct hrtimer *timer) | 467 | int hrtimer_try_to_cancel(struct hrtimer *timer) |
473 | { | 468 | { |
@@ -489,7 +484,6 @@ EXPORT_SYMBOL_GPL(hrtimer_try_to_cancel); | |||
489 | 484 | ||
490 | /** | 485 | /** |
491 | * hrtimer_cancel - cancel a timer and wait for the handler to finish. | 486 | * hrtimer_cancel - cancel a timer and wait for the handler to finish. |
492 | * | ||
493 | * @timer: the timer to be cancelled | 487 | * @timer: the timer to be cancelled |
494 | * | 488 | * |
495 | * Returns: | 489 | * Returns: |
@@ -510,7 +504,6 @@ EXPORT_SYMBOL_GPL(hrtimer_cancel); | |||
510 | 504 | ||
511 | /** | 505 | /** |
512 | * hrtimer_get_remaining - get remaining time for the timer | 506 | * hrtimer_get_remaining - get remaining time for the timer |
513 | * | ||
514 | * @timer: the timer to read | 507 | * @timer: the timer to read |
515 | */ | 508 | */ |
516 | ktime_t hrtimer_get_remaining(const struct hrtimer *timer) | 509 | ktime_t hrtimer_get_remaining(const struct hrtimer *timer) |
@@ -564,7 +557,6 @@ ktime_t hrtimer_get_next_event(void) | |||
564 | 557 | ||
565 | /** | 558 | /** |
566 | * hrtimer_init - initialize a timer to the given clock | 559 | * hrtimer_init - initialize a timer to the given clock |
567 | * | ||
568 | * @timer: the timer to be initialized | 560 | * @timer: the timer to be initialized |
569 | * @clock_id: the clock to be used | 561 | * @clock_id: the clock to be used |
570 | * @mode: timer mode abs/rel | 562 | * @mode: timer mode abs/rel |
@@ -588,7 +580,6 @@ EXPORT_SYMBOL_GPL(hrtimer_init); | |||
588 | 580 | ||
589 | /** | 581 | /** |
590 | * hrtimer_get_res - get the timer resolution for a clock | 582 | * hrtimer_get_res - get the timer resolution for a clock |
591 | * | ||
592 | * @which_clock: which clock to query | 583 | * @which_clock: which clock to query |
593 | * @tp: pointer to timespec variable to store the resolution | 584 | * @tp: pointer to timespec variable to store the resolution |
594 | * | 585 | * |