timekeeping: Fix kerneldoc system_device_crosststamp & al
authorKurt Kanzenbach <kurt@linutronix.de>
Tue, 9 Jun 2020 08:17:26 +0000 (10:17 +0200)
committerThomas Gleixner <tglx@linutronix.de>
Thu, 18 Jun 2020 09:37:03 +0000 (11:37 +0200)
Make kernel doc comments actually work and fix the syncronized typo.

[ tglx: Added the missing /** and fixed up formatting ]

Signed-off-by: Kurt Kanzenbach <kurt@linutronix.de>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://lkml.kernel.org/r/20200609081726.5657-1-kurt@linutronix.de
include/linux/timekeeping.h

index b27e2ff..d5471d6 100644 (file)
@@ -222,9 +222,9 @@ extern bool timekeeping_rtc_skipresume(void);
 
 extern void timekeeping_inject_sleeptime64(const struct timespec64 *delta);
 
-/*
+/**
  * struct system_time_snapshot - simultaneous raw/real time capture with
- *     counter value
+ *                              counter value
  * @cycles:    Clocksource counter value to produce the system times
  * @real:      Realtime system time
  * @raw:       Monotonic raw system time
@@ -239,9 +239,9 @@ struct system_time_snapshot {
        u8              cs_was_changed_seq;
 };
 
-/*
+/**
  * struct system_device_crosststamp - system/device cross-timestamp
- *     (syncronized capture)
+ *                                   (synchronized capture)
  * @device:            Device time
  * @sys_realtime:      Realtime simultaneous with device time
  * @sys_monoraw:       Monotonic raw simultaneous with device time
@@ -252,12 +252,12 @@ struct system_device_crosststamp {
        ktime_t sys_monoraw;
 };
 
-/*
+/**
  * struct system_counterval_t - system counter value with the pointer to the
- *     corresponding clocksource
+ *                             corresponding clocksource
  * @cycles:    System counter value
  * @cs:                Clocksource corresponding to system counter value. Used by
- *     timekeeping code to verify comparibility of two cycle values
+ *             timekeeping code to verify comparibility of two cycle values
  */
 struct system_counterval_t {
        u64                     cycles;