[coreboot-gerrit] [S] Change in coreboot[main]: [RFC][POC] include/timestamp.h: Format docstrings for Doxygen

[Nicholas Chin (Code Review)]

Nicholas Chin has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/87228?usp=email )

Change subject: [RFC][POC] include/timestamp.h: Format docstrings for Doxygen
......................................................................

[RFC][POC] include/timestamp.h: Format docstrings for Doxygen

Change-Id: Id93aedae199b8458fd5a2c049306f16fc896ef9c
Signed-off-by: Nicholas Chin 
---
M src/include/timestamp.h
1 file changed, 7 insertions(+), 7 deletions(-)

git pull ssh://review.coreboot.org:29418/coreboot refs/changes/28/87228/1

diff --git a/src/include/timestamp.h b/src/include/timestamp.h
index 06c3058..d30bf23 100644
--- a/src/include/timestamp.h
+++ b/src/include/timestamp.h
@@ -7,26 +7,26 @@
 #include <stdint.h>

#if CONFIG(COLLECT_TIMESTAMPS)
-/*
+/**
  * timestamp_init() needs to be called once in *one* of the ENV_ROMSTAGE_OR_BEFORE
  * stages (bootblock, romstage, verstage, etc). It's up to the chipset/arch
  * to make the call in the earliest stage, otherwise some timestamps will be lost.
  * For x86 ENV_BOOTBLOCK / ENV_SEPARATE_ROMSTAGE call must be made before CAR is torn down.
  */
 void timestamp_init(uint64_t base);
-/*
+/**
  * Add a new timestamp. For ENV_ROMSTAGE_OR_BEFORE, this timestamp will be stored
  * inside REGION(timestamp) before cbmem comes online. For later stages, timestamps
  * added before cbmem_[recovery|initialize] calls will be lost.
  */
 void timestamp_add(enum timestamp_id id, int64_t ts_time);
-/* Calls timestamp_add with current timestamp. */
+/** Calls timestamp_add with current timestamp. */
 void timestamp_add_now(enum timestamp_id id);

-/* Apply a factor of N/M to all timestamps recorded so far. */
+/** Apply a factor of N/M to all timestamps recorded so far. */
 void timestamp_rescale_table(uint16_t N, uint16_t M);

-/*
+/**
  * Get the time since boot scaled in microseconds. Therefore use the base time
  * of the timestamps to get the initial value which is subtracted from
  * current timestamp at call time. This will provide a more reliable value even
@@ -46,14 +46,14 @@
  * Workaround for guard combination above.
  */
 #if CONFIG(COLLECT_TIMESTAMPS)
-/* Implemented by the architecture code */
+/** Implemented by the architecture code */
 uint64_t timestamp_get(void);
 #else
 #define timestamp_get() 0
 #endif

uint64_t get_initial_timestamp(void);
-/* Returns timestamp tick frequency in MHz. */
+/** Returns timestamp tick frequency in MHz. */
 int timestamp_tick_freq_mhz(void);

#endif