Fix nasa#2410: document ES Perf enums

irowebbn · Dec 5, 2023 · 499b8b4 · 499b8b4
1 parent ee18742
commit 499b8b4
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 8 deletions.
diff --git a/modules/es/config/default_cfe_es_msgstruct.h b/modules/es/config/default_cfe_es_msgstruct.h
@@ -195,6 +195,17 @@ typedef struct CFE_ES_DeleteCDSCmd
     CFE_ES_DeleteCDSCmd_Payload_t Payload;       /**< \brief Command payload */
 } CFE_ES_DeleteCDSCmd_t;
 
+/**
+** \brief Start Performance Analyzer Command Payload
+**
+** For command details, see #CFE_ES_START_PERF_DATA_CC
+**
+**/
+typedef struct CFE_ES_StartPerfCmd_Payload
+{
+    uint32 TriggerMode; /**< \brief Desired trigger position (Start, Center, End). Values defined by #CFE_ES_PerfMode. */
+} CFE_ES_StartPerfCmd_Payload_t;
+
 /**
  * \brief Start Performance Analyzer Command
  */

diff --git a/modules/es/fsw/src/cfe_es_perf.h b/modules/es/fsw/src/cfe_es_perf.h
@@ -41,24 +41,36 @@
 **  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,
     CFE_ES_PERF_TRIGGERED,
     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,
     CFE_ES_PERF_TRIGGER_END,
     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 */