diff options
| author | Anna-Maria Behnsen <anna-maria@linutronix.de> | 2024-01-23 17:46:59 +0100 |
|---|---|---|
| committer | Thomas Gleixner <tglx@linutronix.de> | 2024-02-19 09:38:00 +0100 |
| commit | c92a7eb6c642812fb08851e580973c3b83e0227c (patch) | |
| tree | 01a9c7d28b4ee7609a24271888b0ace98ec6fe34 /include/linux/jiffies.h | |
| parent | 892abd357183bc663d6984d10c62f94b40bfc375 (diff) | |
| download | linux-c92a7eb6c642812fb08851e580973c3b83e0227c.tar.gz | |
jiffies: Transform comment about time_* functions into DOC block
This general note about time_* functions is also useful to be available in
kernel documentation. Therefore transform it into a kernel-doc DOC block
with proper formatting.
Signed-off-by: Anna-Maria Behnsen <anna-maria@linutronix.de>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/r/20240123164702.55612-6-anna-maria@linutronix.de
Diffstat (limited to 'include/linux/jiffies.h')
| -rw-r--r-- | include/linux/jiffies.h | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/include/linux/jiffies.h b/include/linux/jiffies.h index e0ae2a43e0ebd..d9f1435a5a13c 100644 --- a/include/linux/jiffies.h +++ b/include/linux/jiffies.h @@ -102,12 +102,15 @@ static inline u64 get_jiffies_64(void) } #endif -/* - * These inlines deal with timer wrapping correctly. You are - * strongly encouraged to use them: - * 1. Because people otherwise forget - * 2. Because if the timer wrap changes in future you won't have to - * alter your driver code. +/** + * DOC: General information about time_* inlines + * + * These inlines deal with timer wrapping correctly. You are strongly encouraged + * to use them: + * + * #. Because people otherwise forget + * #. Because if the timer wrap changes in future you won't have to alter your + * driver code. */ /** |