Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit fa9799e3 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

[PATCH] ktime/hrtimer: fix kernel-doc comments



Fix kernel-doc formatting in ktime.h and hrtimer.[ch] files.

Signed-off-by: default avatarRandy Dunlap <rdunlap@xenotime.net>
Signed-off-by: default avatarAndrew Morton <akpm@osdl.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@osdl.org>
parent 9dc65576
Loading
Loading
Loading
Loading
+0 −3
Original line number Original line Diff line number Diff line
@@ -40,7 +40,6 @@ struct hrtimer_base;


/**
/**
 * struct hrtimer - the basic hrtimer structure
 * struct hrtimer - the basic hrtimer structure
 *
 * @node:	red black tree node for time ordered insertion
 * @node:	red black tree node for time ordered insertion
 * @expires:	the absolute expiry time in the hrtimers internal
 * @expires:	the absolute expiry time in the hrtimers internal
 *		representation. The time is related to the clock on
 *		representation. The time is related to the clock on
@@ -59,7 +58,6 @@ struct hrtimer {


/**
/**
 * struct hrtimer_sleeper - simple sleeper structure
 * struct hrtimer_sleeper - simple sleeper structure
 *
 * @timer:	embedded timer structure
 * @timer:	embedded timer structure
 * @task:	task to wake up
 * @task:	task to wake up
 *
 *
@@ -72,7 +70,6 @@ struct hrtimer_sleeper {


/**
/**
 * struct hrtimer_base - the timer base for a specific clock
 * struct hrtimer_base - the timer base for a specific clock
 *
 * @index:		clock type index for per_cpu support when moving a timer
 * @index:		clock type index for per_cpu support when moving a timer
 *			to a base on another cpu.
 *			to a base on another cpu.
 * @lock:		lock protecting the base and associated timers
 * @lock:		lock protecting the base and associated timers
+0 −8
Original line number Original line Diff line number Diff line
@@ -66,7 +66,6 @@ typedef union {


/**
/**
 * ktime_set - Set a ktime_t variable from a seconds/nanoseconds value
 * ktime_set - Set a ktime_t variable from a seconds/nanoseconds value
 *
 * @secs:	seconds to set
 * @secs:	seconds to set
 * @nsecs:	nanoseconds 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
 * ktime_sub - subtract two ktime_t variables
 *
 * @lhs:	minuend
 * @lhs:	minuend
 * @rhs:	subtrahend
 * @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
 * ktime_add - add two ktime_t variables
 *
 * @add1:	addend1
 * @add1:	addend1
 * @add2:	addend2
 * @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
 * ktime_add_ns - Add a scalar nanoseconds value to a ktime_t variable
 *
 * @kt:		addend
 * @kt:		addend
 * @nsec:	the scalar nsec value to add
 * @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
 * timespec_to_ktime - convert a timespec to ktime_t format
 *
 * @ts:		the timespec variable to convert
 * @ts:		the timespec variable to convert
 *
 *
 * Returns a ktime_t variable with the converted timespec value
 * 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
 * timeval_to_ktime - convert a timeval to ktime_t format
 *
 * @tv:		the timeval variable to convert
 * @tv:		the timeval variable to convert
 *
 *
 * Returns a ktime_t variable with the converted timeval value
 * 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
 * ktime_to_timespec - convert a ktime_t variable to timespec format
 *
 * @kt:		the ktime_t variable to convert
 * @kt:		the ktime_t variable to convert
 *
 *
 * Returns the timespec representation of the ktime value
 * 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
 * ktime_to_timeval - convert a ktime_t variable to timeval format
 *
 * @kt:		the ktime_t variable to convert
 * @kt:		the ktime_t variable to convert
 *
 *
 * Returns the timeval representation of the ktime value
 * Returns the timeval representation of the ktime value
+1 −10
Original line number Original line Diff line number Diff line
@@ -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
 * ktime_get_ts - get the monotonic clock in timespec format
 *
 * @ts:		pointer to timespec variable
 * @ts:		pointer to timespec variable
 *
 *
 * The function calculates the monotonic clock from the realtime
 * 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
# ifndef CONFIG_KTIME_SCALAR
/**
/**
 * ktime_add_ns - Add a scalar nanoseconds value to a ktime_t variable
 * ktime_add_ns - Add a scalar nanoseconds value to a ktime_t variable
 *
 * @kt:		addend
 * @kt:		addend
 * @nsec:	the scalar nsec value to add
 * @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
 * hrtimer_forward - forward the timer expiry
 *
 * @timer:	hrtimer to forward
 * @timer:	hrtimer to forward
 * @now:	forward past this time
 * @now:	forward past this time
 * @interval:	the interval to forward
 * @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
 * hrtimer_start - (re)start an relative timer on the current CPU
 *
 * @timer:	the timer to be added
 * @timer:	the timer to be added
 * @tim:	expiry time
 * @tim:	expiry time
 * @mode:	expiry mode: absolute (HRTIMER_ABS) or relative (HRTIMER_REL)
 * @mode:	expiry mode: absolute (HRTIMER_ABS) or relative (HRTIMER_REL)
@@ -460,7 +456,6 @@ EXPORT_SYMBOL_GPL(hrtimer_start);


/**
/**
 * hrtimer_try_to_cancel - try to deactivate a timer
 * hrtimer_try_to_cancel - try to deactivate a timer
 *
 * @timer:	hrtimer to stop
 * @timer:	hrtimer to stop
 *
 *
 * Returns:
 * Returns:
@@ -489,7 +484,6 @@ EXPORT_SYMBOL_GPL(hrtimer_try_to_cancel);


/**
/**
 * hrtimer_cancel - cancel a timer and wait for the handler to finish.
 * hrtimer_cancel - cancel a timer and wait for the handler to finish.
 *
 * @timer:	the timer to be cancelled
 * @timer:	the timer to be cancelled
 *
 *
 * Returns:
 * Returns:
@@ -510,7 +504,6 @@ EXPORT_SYMBOL_GPL(hrtimer_cancel);


/**
/**
 * hrtimer_get_remaining - get remaining time for the timer
 * hrtimer_get_remaining - get remaining time for the timer
 *
 * @timer:	the timer to read
 * @timer:	the timer to read
 */
 */
ktime_t hrtimer_get_remaining(const struct hrtimer *timer)
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
 * hrtimer_init - initialize a timer to the given clock
 *
 * @timer:	the timer to be initialized
 * @timer:	the timer to be initialized
 * @clock_id:	the clock to be used
 * @clock_id:	the clock to be used
 * @mode:	timer mode abs/rel
 * @mode:	timer mode abs/rel
@@ -588,7 +580,6 @@ EXPORT_SYMBOL_GPL(hrtimer_init);


/**
/**
 * hrtimer_get_res - get the timer resolution for a clock
 * hrtimer_get_res - get the timer resolution for a clock
 *
 * @which_clock: which clock to query
 * @which_clock: which clock to query
 * @tp:		 pointer to timespec variable to store the resolution
 * @tp:		 pointer to timespec variable to store the resolution
 *
 *