[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>
This commit is contained in:
Randy Dunlap
Linus Torvalds
parent
9dc65576d6
commit
fa9799e33d
|
|
@ -40,7 +40,6 @@ struct hrtimer_base;
|
|||
|
||||
/**
|
||||
* struct hrtimer - the basic hrtimer structure
|
||||
*
|
||||
* @node: red black tree node for time ordered insertion
|
||||
* @expires: the absolute expiry time in the hrtimers internal
|
||||
* representation. The time is related to the clock on
|
||||
|
|
@ -59,7 +58,6 @@ struct hrtimer {
|
|||
|
||||
/**
|
||||
* struct hrtimer_sleeper - simple sleeper structure
|
||||
*
|
||||
* @timer: embedded timer structure
|
||||
* @task: task to wake up
|
||||
*
|
||||
|
|
@ -72,7 +70,6 @@ struct hrtimer_sleeper {
|
|||
|
||||
/**
|
||||
* struct hrtimer_base - the timer base for a specific clock
|
||||
*
|
||||
* @index: clock type index for per_cpu support when moving a timer
|
||||
* to a base on another cpu.
|
||||
* @lock: lock protecting the base and associated timers
|
||||
|
|
|
|||
|
|
@ -66,7 +66,6 @@ typedef union {
|
|||
|
||||
/**
|
||||
* ktime_set - Set a ktime_t variable from a seconds/nanoseconds value
|
||||
*
|
||||
* @secs: seconds to set
|
||||
* @nsecs: nanoseconds to set
|
||||
*
|
||||
|
|
@ -138,7 +137,6 @@ static inline ktime_t ktime_set(const long secs, const unsigned long nsecs)
|
|||
|
||||
/**
|
||||
* ktime_sub - subtract two ktime_t variables
|
||||
*
|
||||
* @lhs: minuend
|
||||
* @rhs: subtrahend
|
||||
*
|
||||
|
|
@ -157,7 +155,6 @@ static inline ktime_t ktime_sub(const ktime_t lhs, const ktime_t rhs)
|
|||
|
||||
/**
|
||||
* ktime_add - add two ktime_t variables
|
||||
*
|
||||
* @add1: addend1
|
||||
* @add2: addend2
|
||||
*
|
||||
|
|
@ -184,7 +181,6 @@ static inline ktime_t ktime_add(const ktime_t add1, const ktime_t add2)
|
|||
|
||||
/**
|
||||
* ktime_add_ns - Add a scalar nanoseconds value to a ktime_t variable
|
||||
*
|
||||
* @kt: addend
|
||||
* @nsec: the scalar nsec value to add
|
||||
*
|
||||
|
|
@ -194,7 +190,6 @@ extern ktime_t ktime_add_ns(const ktime_t kt, u64 nsec);
|
|||
|
||||
/**
|
||||
* timespec_to_ktime - convert a timespec to ktime_t format
|
||||
*
|
||||
* @ts: the timespec variable to convert
|
||||
*
|
||||
* 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)
|
|||
|
||||
/**
|
||||
* timeval_to_ktime - convert a timeval to ktime_t format
|
||||
*
|
||||
* @tv: the timeval variable to convert
|
||||
*
|
||||
* 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)
|
|||
|
||||
/**
|
||||
* ktime_to_timespec - convert a ktime_t variable to timespec format
|
||||
*
|
||||
* @kt: the ktime_t variable to convert
|
||||
*
|
||||
* Returns the timespec representation of the ktime value
|
||||
|
|
@ -233,7 +226,6 @@ static inline struct timespec ktime_to_timespec(const ktime_t kt)
|
|||
|
||||
/**
|
||||
* ktime_to_timeval - convert a ktime_t variable to timeval format
|
||||
*
|
||||
* @kt: the ktime_t variable to convert
|
||||
*
|
||||
* Returns the timeval representation of the ktime value
|
||||
|
|
|
|||
|
|
@ -98,7 +98,6 @@ static DEFINE_PER_CPU(struct hrtimer_base, hrtimer_bases[MAX_HRTIMER_BASES]) =
|
|||
|
||||
/**
|
||||
* ktime_get_ts - get the monotonic clock in timespec format
|
||||
*
|
||||
* @ts: pointer to timespec variable
|
||||
*
|
||||
* The function calculates the monotonic clock from the realtime
|
||||
|
|
@ -238,7 +237,6 @@ lock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags)
|
|||
# ifndef CONFIG_KTIME_SCALAR
|
||||
/**
|
||||
* ktime_add_ns - Add a scalar nanoseconds value to a ktime_t variable
|
||||
*
|
||||
* @kt: addend
|
||||
* @nsec: the scalar nsec value to add
|
||||
*
|
||||
|
|
@ -299,7 +297,6 @@ void unlock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags)
|
|||
|
||||
/**
|
||||
* hrtimer_forward - forward the timer expiry
|
||||
*
|
||||
* @timer: hrtimer to forward
|
||||
* @now: forward past this time
|
||||
* @interval: the interval to forward
|
||||
|
|
@ -411,7 +408,6 @@ remove_hrtimer(struct hrtimer *timer, struct hrtimer_base *base)
|
|||
|
||||
/**
|
||||
* hrtimer_start - (re)start an relative timer on the current CPU
|
||||
*
|
||||
* @timer: the timer to be added
|
||||
* @tim: expiry time
|
||||
* @mode: expiry mode: absolute (HRTIMER_ABS) or relative (HRTIMER_REL)
|
||||
|
|
@ -460,14 +456,13 @@ EXPORT_SYMBOL_GPL(hrtimer_start);
|
|||
|
||||
/**
|
||||
* hrtimer_try_to_cancel - try to deactivate a timer
|
||||
*
|
||||
* @timer: hrtimer to stop
|
||||
*
|
||||
* Returns:
|
||||
* 0 when the timer was not active
|
||||
* 1 when the timer was active
|
||||
* -1 when the timer is currently excuting the callback function and
|
||||
* can not be stopped
|
||||
* cannot be stopped
|
||||
*/
|
||||
int hrtimer_try_to_cancel(struct hrtimer *timer)
|
||||
{
|
||||
|
|
@ -489,7 +484,6 @@ EXPORT_SYMBOL_GPL(hrtimer_try_to_cancel);
|
|||
|
||||
/**
|
||||
* hrtimer_cancel - cancel a timer and wait for the handler to finish.
|
||||
*
|
||||
* @timer: the timer to be cancelled
|
||||
*
|
||||
* Returns:
|
||||
|
|
@ -510,7 +504,6 @@ EXPORT_SYMBOL_GPL(hrtimer_cancel);
|
|||
|
||||
/**
|
||||
* hrtimer_get_remaining - get remaining time for the timer
|
||||
*
|
||||
* @timer: the timer to read
|
||||
*/
|
||||
ktime_t hrtimer_get_remaining(const struct hrtimer *timer)
|
||||
|
|
@ -564,7 +557,6 @@ ktime_t hrtimer_get_next_event(void)
|
|||
|
||||
/**
|
||||
* hrtimer_init - initialize a timer to the given clock
|
||||
*
|
||||
* @timer: the timer to be initialized
|
||||
* @clock_id: the clock to be used
|
||||
* @mode: timer mode abs/rel
|
||||
|
|
@ -588,7 +580,6 @@ EXPORT_SYMBOL_GPL(hrtimer_init);
|
|||
|
||||
/**
|
||||
* hrtimer_get_res - get the timer resolution for a clock
|
||||
*
|
||||
* @which_clock: which clock to query
|
||||
* @tp: pointer to timespec variable to store the resolution
|
||||
*
|
||||
|
|
|
|||
Reference in New Issue