Commit c92a7eb6 authored by Anna-Maria Behnsen's avatar Anna-Maria Behnsen Committed by Thomas Gleixner
Browse files

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: default avatarAnna-Maria Behnsen <anna-maria@linutronix.de>
Signed-off-by: default avatarThomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/r/20240123164702.55612-6-anna-maria@linutronix.de
parent 892abd35

include/linux/jiffies.h

+9 −6
Original line number Diff line number Diff line
@@ -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.

 */



/**