From 1733ffefcf65f86f80734a5529fc34a819749de7 Mon Sep 17 00:00:00 2001
From: Isaac Rowe <9010221+irowebbn@users.noreply.github.com>
Date: Fri, 21 Jul 2023 12:32:36 -0500
Subject: [PATCH] Fix #2410, document ES Perf enums

---
 modules/es/config/default_cfe_es_msgdefs.h |  2 +-
 modules/es/fsw/src/cfe_es_perf.h           | 30 ++++++++++++++++------
 2 files changed, 23 insertions(+), 9 deletions(-)

diff --git a/modules/es/config/default_cfe_es_msgdefs.h b/modules/es/config/default_cfe_es_msgdefs.h
index 61dd65dee..aae254ff0 100644
--- a/modules/es/config/default_cfe_es_msgdefs.h
+++ b/modules/es/config/default_cfe_es_msgdefs.h
@@ -151,7 +151,7 @@ typedef struct CFE_ES_DeleteCDSCmd_Payload
 **/
 typedef struct CFE_ES_StartPerfCmd_Payload
 {
-    uint32 TriggerMode; /**< \brief Desired trigger position (Start, Center, End) */
+    uint32 TriggerMode; /**< \brief Desired trigger position (Start, Center, End). Values defined by #CFE_ES_PerfMode. */
 } CFE_ES_StartPerfCmd_Payload_t;
 
 /**
diff --git a/modules/es/fsw/src/cfe_es_perf.h b/modules/es/fsw/src/cfe_es_perf.h
index 1431b8d2f..f0244ff98 100644
--- a/modules/es/fsw/src/cfe_es_perf.h
+++ b/modules/es/fsw/src/cfe_es_perf.h
@@ -41,7 +41,15 @@
 **  Defines
 */
 
-enum CFE_ES_PerfState_t
+
+/** @defgroup CFEESPerf Performance Analyzer Data Structures
+ * @{
+ */
+
+/**
+ * @brief Internal states for Performance Analyzer
+ */
+enum CFE_ES_PerfState
 {
     CFE_ES_PERF_IDLE = 0,
     CFE_ES_PERF_WAITING_FOR_TRIGGER,
@@ -49,7 +57,11 @@ enum CFE_ES_PerfState_t
     CFE_ES_PERF_MAX_STATES
 };
 
-enum CFE_ES_PerfMode_t
+/**
+ * @brief Labels for values to use in #CFE_ES_StartPerfCmd_Payload.TriggerMode
+ * @sa CFE_ES_StartPerfCmd_Payload
+*/
+enum CFE_ES_PerfMode
 {
     CFE_ES_PERF_TRIGGER_START = 0,
     CFE_ES_PERF_TRIGGER_CENTER,
@@ -57,8 +69,8 @@ enum CFE_ES_PerfMode_t
     CFE_ES_PERF_MAX_MODES
 };
 
-/*
- * Perflog Dump Background Job states
+/**
+ * @brief Perflog Dump Background Job states
  *
  * Writing performance log data is now handled by a state machine that runs
  * as a background job in Executive services.  When a performance log dump is
@@ -81,8 +93,8 @@ typedef enum
     CFE_ES_PerfDumpState_MAX                  /* Placeholder for last state, no action, always last */
 } CFE_ES_PerfDumpState_t;
 
-/*
- * Performance log dump state structure
+/**
+ * @brief Performance log dump state structure
  *
  * This structure is stored in global memory and keeps the state
  * of the performance log dump from one iteration to the next.
@@ -110,8 +122,8 @@ typedef struct
     size_t    FileSize;                      /* Total file size, for progress reporting in telemetry */
 } CFE_ES_PerfDumpGlobal_t;
 
-/*
- * Helper function to obtain the progress/remaining items from
+/**
+ * @brief Helper function to obtain the progress/remaining items from
  * the background task that is writing the performance log data
  *
  * This is no longer just simply reading a single value from a struct,
@@ -137,4 +149,6 @@ uint32 CFE_ES_GetPerfLogDumpRemaining(void);
  */
 bool CFE_ES_RunPerfLogDump(uint32 ElapsedTime, void *Arg);
 
+/** @} */
+
 #endif /* CFE_ES_PERF_H */