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

[Nicholas Chin (Code Review)]

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

Change subject: [POC] include/timestamp.h: Format docstrings for kernel-doc
......................................................................

[POC] include/timestamp.h: Format docstrings for kernel-doc

Format the docstrings for a few functions declared in timestamp.h so
that they are recognized by kernel-doc.

Documentation for the syntax of such docstrings can be found at
https://docs.kernel.org/doc-guide/kernel-doc.html.

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

git pull ssh://review.coreboot.org:29418/coreboot refs/changes/67/87467/1

diff --git a/src/include/timestamp.h b/src/include/timestamp.h
index 06c3058..37ceae1 100644
--- a/src/include/timestamp.h
+++ b/src/include/timestamp.h
@@ -7,20 +7,27 @@
 #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.
+/**
+ * timestamp_init: Initializes the timestamp system with a base time.
+ *
+ * This function 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
+/**
+ * timestamp_add - 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. */
+/**
+ * timestamp_add_now - 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. */