From: Tom Rini <trini@konsulko.com>
Date: Mon, 4 Sep 2023 15:19:50 +0000 (-0400)
Subject: event.h: Documented some newly added portions better
X-Git-Url: http://git.dujemihanovic.xyz/?a=commitdiff_plain;h=b53ab97150314674edc25508f4fc528be2baa73f;p=u-boot.git

event.h: Documented some newly added portions better

After the merge of v2023.10-rc4 to next include/event.h needs to be
fully documented in order for documentation builds to complete.  Rewords
two of the event_t descriptions to be docbook style and better match the
rest of this enum.  Fix two typos (flag->flags) in other comments.

Signed-off-by: Tom Rini <trini@konsulko.com>
---

diff --git a/include/event.h b/include/event.h
index c37deae945..311df878c4 100644
--- a/include/event.h
+++ b/include/event.h
@@ -94,18 +94,19 @@ enum event_t {
 	 */
 	EVT_MISC_INIT_F,
 
-	/*
-	 * Emitted before relocation to set up Firmware Support Package
-	 *
+	/**
+	 * @EVT_FSP_INIT_F:
+	 * This event is triggered before relocation to set up Firmware Support
+	 * Package.
 	 * Where U-Boot relies on binary blobs to handle part of the system
 	 * init, this event can be used to set up the blobs. This is used on
 	 * some Intel platforms
 	 */
 	EVT_FSP_INIT_F,
 
-	/*
-	 * Emitted just before jumping to the main loop
-	 *
+	/**
+	 * @EVT_LAST_STAGE_INIT:
+	 * This event is triggered just before jumping to the main loop.
 	 * Some boards need to perform initialisation immediately before control
 	 * is passed to the command-line interpreter (e.g. for init that depend
 	 * on later phases in the init sequence).
@@ -222,7 +223,7 @@ typedef int (*event_handler_simple_t)(void);
  *
  * @func: Function to call when the event is activated (must be first)
  * @type: Event type
- * @flag: Flags for this spy
+ * @flags: Flags for this spy
  * @id: Event id string
  */
 struct evspy_info {
@@ -241,7 +242,7 @@ struct evspy_info {
  *
  * @func: Function to call when the event is activated (must be first)
  * @type: Event type
- * @flag: Flags for this spy
+ * @flags: Flags for this spy
  * @id: Event id string
  */
 struct evspy_info_simple {