diff --git a/cmake/cfe-common.doxyfile.in b/cmake/cfe-common.doxyfile.in
index 8e504d4af..68944bb60 100644
--- a/cmake/cfe-common.doxyfile.in
+++ b/cmake/cfe-common.doxyfile.in
@@ -14,8 +14,7 @@ ABBREVIATE_BRIEF = "The $name class " \
an \
the
TAB_SIZE = 8
-ALIASES += "event=\xrefitem cfeevents \"Event Message\" \"cFE Event Message Cross Reference\" " \
- "cfeescfg=\xrefitem cfeescfg \"Purpose\" \"cFE Executive Services Configuration Parameters\" " \
+ALIASES += "cfeescfg=\xrefitem cfeescfg \"Purpose\" \"cFE Executive Services Configuration Parameters\" " \
"cfeevscfg=\xrefitem cfeevscfg \"Purpose\" \"cFE Event Services Configuration Parameters\" " \
"cfetblcfg=\xrefitem cfetblcfg \"Purpose\" \"cFE Table Services Configuration Parameters\" " \
"cfetimecfg=\xrefitem cfetimecfg \"Purpose\" \"cFE Time Services Configuration Parameters\" " \
diff --git a/modules/es/fsw/inc/cfe_es_events.h b/modules/es/fsw/inc/cfe_es_events.h
index 5024fa38b..910eb93f9 100644
--- a/modules/es/fsw/inc/cfe_es_events.h
+++ b/modules/es/fsw/inc/cfe_es_events.h
@@ -21,1431 +21,1044 @@
/**
* @file
*
- * Purpose:
- * cFE Executive Services (ES) Event IDs
- *
- * References:
- * Flight Software Branch C Coding Standard Version 1.0a
- * cFE Flight Software Application Developers Guide
- *
- * Notes:
- *
+ * cFE Executive Services Event IDs
*/
#ifndef CFE_ES_EVENTS_H
#define CFE_ES_EVENTS_H
-/* **************************
-** ****** Maximum EID. ******
-** **************************
-** The EID's below may not necessarily be in order, so it can be difficult to
-** determine what the next EID is to use. When you add EID's, start with MAX_EID + 1
-** and when you're done adding, set this to the highest EID you used. It may
-** be worthwhile to, on occasion, re-number the EID's to put them back in order.
-*/
-#define CFE_ES_MAX_EID 92
-
-/*
-** ES task event message ID's.
-*/
+/**
+ * \name ES event IDs
+ */
+/**\{*/
-/** \brief 'cFE ES Initialized'
-** \event 'cFE ES Initialized'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always automatically issued when the Executive Services
-** Task completes its Initialization.
-**/
-#define CFE_ES_INIT_INF_EID 1 /* start up message "informational" */
+/**
+ * \brief ES Initialization Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * Executive Services Task initialization complete.
+ */
+#define CFE_ES_INIT_INF_EID 1
-/** \brief 'cFE Version \%d.\%d.\%d chksm \%d, OSAL Version \%d.\%d'
-** \event 'cFE Version \%d.\%d.\%d chksm \%d, OSAL Version \%d.\%d'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always automatically issued when the Executive Services
-** Task completes its Initialization.
-**
-** The \c Version field identifies the tagged version for the cFE Build, the \c chksm field
-** provides the 16-bit checksum of the cFE Build and the \c OSAL \c Version field identifies
-** the version of the OS Abstraction Layer on which this particular version of the cFE was built.
-**/
+/**
+ * \brief ES Initialization Statistics Information Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * Executive Services Task initialization complete.
+ */
#define CFE_ES_INITSTATS_INF_EID 2
-/** \brief 'No-op command'
-** \event 'No-op command'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always automatically issued in response
-** to a cFE Executive Services \link #CFE_ES_NOOP_CC NO-OP command \endlink
-**/
-#define CFE_ES_NOOP_INF_EID 3 /* processed command "informational" */
+/**
+ * \brief ES No-op Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_NOOP_CC ES No-op Command \endlink success.
+ */
+#define CFE_ES_NOOP_INF_EID 3
-/** \brief 'Reset Counters command'
-** \event 'Reset Counters command'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always automatically issued in response
-** to a cFE Executive Services \link #CFE_ES_RESET_COUNTERS_CC Reset Counters command \endlink
-**/
+/**
+ * \brief ES Reset Counters Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_RESET_COUNTERS_CC ES Reset Counters Command \endlink success.
+ */
#define CFE_ES_RESET_INF_EID 4
-/** \brief 'Started \%s from \%s, AppID = \%d'
-** \event 'Started \%s from \%s, AppID = \%d'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is automatically issued upon successful completion of
-** a cFE Executive Services \link #CFE_ES_START_APP_CC Start Application command \endlink
-**
-** The first \c 's' string identifies the name of the started Application, the
-** second \c 's' string identifies the filename from which the Application was
-** loaded and the \c AppId field specifies the Application ID assigned to the
-** newly started Application by the cFE Executive Services.
-**/
+/**
+ * \brief ES Start Application Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_START_APP_CC ES Start Application Command \endlink success.
+ */
#define CFE_ES_START_INF_EID 6
-/** \brief 'Stop Application \%s Initiated.'
-** \event 'Stop Application \%s Initiated.'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is issued upon successful processing of the
-** cFE Executive Services \link #CFE_ES_STOP_APP_CC Stop Application command \endlink
-** Note that when this event is displayed, the Application is not deleted. ES has
-** accepted the request to delete the application, and it will be deleted after the app exits
-** it's main loop, or times out.
-**
-** The \c 's' field identifies the name of the Application that will be stopped.
-**/
+/**
+ * \brief ES Stop Application Command Request Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_STOP_APP_CC ES Stop Application Command \endlink success.
+ * Note this event signifies the request to delete the application has been successfully
+ * submitted. The successful completion will generate a #CFE_ES_STOP_INF_EID event.
+ */
#define CFE_ES_STOP_DBG_EID 7
-/** \brief 'Stop Application \%s Completed.'
-** \event 'Stop Application \%s Completed.'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is issued when the cFE finishes deleting the cFE Application
-** That was started when the \link #CFE_ES_STOP_APP_CC Stop Application command \endlink
-** was issued.
-**
-** The \c 's' field identifies the name of the Application that was stopped.
-*/
+/**
+ * \brief ES Stop Application Completed Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * Request to delete an application successfully completed.
+ */
#define CFE_ES_STOP_INF_EID 8
-/** \brief 'Restart Application \%s Initiated.'
-** \event 'Restart Application \%s Initiated.'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is issued upon successful processing of the
-** cFE Executive Services \link #CFE_ES_RESTART_APP_CC Restart Application command \endlink
-** Note that when this event is displayed, the Application is not restarted. ES has
-** accepted the request to restart the application, and it will be restarted after the app exits
-** it's main loop, or times out.
-**
-** The \c 's' field identifies the name of the Application that will be restarted.
-**/
+/**
+ * \brief ES Restart Application Command Request Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_RESTART_APP_CC ES Restart Application Command \endlink success.
+ * Note this event signifies the request to restart the application has been successfully
+ * submitted. The successful completion will generate a #CFE_ES_RESTART_APP_INF_EID event.
+ */
#define CFE_ES_RESTART_APP_DBG_EID 9
-/** \brief 'Restart Application \%s Completed, AppID=%lu'
-** \event 'Restart Application \%s Completed, AppID=%lu'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is issued when the cFE finishes Restarting the cFE Application
-** That was started when the \link #CFE_ES_RESTART_APP_CC Restart Application command \endlink
-** was issued.
-**
-** The \c 's' field identifies the name of the Application that was restarted, and
-** the %lu field identifies the new Application ID
-*/
+/**
+ * \brief ES Restart Application Completed Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * Request to restart an application successfully completed.
+ */
#define CFE_ES_RESTART_APP_INF_EID 10
-/** \brief 'Reload Application \%s Initiated.'
-** \event 'Reload Application \%s Initiated.'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is issued upon successful processing of the
-** cFE Executive Services \link #CFE_ES_RELOAD_APP_CC Reload Application command \endlink
-** Note that when this event is displayed, the Application is not reloaded. ES has
-** accepted the request to reload the application, and it will be reloaded after the app exits
-** it's main loop, or times out.
-**
-** The \c 's' field identifies the name of the Application that will be reloaded.
-**/
+/**
+ * \brief ES Reload Application Command Request Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_RELOAD_APP_CC ES Reload Application Command \endlink success.
+ * Note this event signifies the request to reload the application has been successfully
+ * submitted. The successful completion will generate a #CFE_ES_RELOAD_APP_INF_EID event.
+ */
#define CFE_ES_RELOAD_APP_DBG_EID 11
-/** \brief 'Reload Application \%s Completed, AppID=%lu'
-** \event 'Reload Application \%s Completed, AppID=%lu'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is issued when the cFE finishes Reloading the cFE Application
-** That was started when the \link #CFE_ES_RELOAD_APP_CC Restart Application command \endlink
-** was issued.
-**
-** The \c 's' field identifies the name of the Application that was reloaded, and
-** the %lu field identifies the new Application ID
-*/
+/**
+ * \brief ES Reload Application Complete Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * Request to reload an application successfully completed.
+ */
#define CFE_ES_RELOAD_APP_INF_EID 12
-/** \brief 'Exit Application \%s Completed.'
-** \event 'Exit Application \%s Completed.'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is issued when the cFE finishes exiting/cleaning up an
-** application that called the CFE_ES_ExitApp API with the CFE_ES_RunStatus_APP_EXIT parameter.
-** When an App calls this API, the request is recorded and the Executive Services App will
-** actually delete cFE Application before issuing this event message.
-**
-** The \c 's' field identifies the name of the Application that was exited.
-*/
+/**
+ * \brief ES Nominal Exit Application Complete Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * Nominal request to exit an application successfully completed.
+ * This event indicates the Application exited due to a nominal exit condition.
+ */
#define CFE_ES_EXIT_APP_INF_EID 13
-/** \brief 'Exit Application \%s Completed.'
-** \event 'Exit Application \%s Completed.'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is issued when the cFE finishes exiting/cleaning up an
-** application that called the CFE_ES_ExitApp API with an ERROR condition.
-** When an App calls this API, with the CFE_ES_RunStatus_APP_ERROR parameter, it indicates
-** that the Application exited due to an error condition. The details of the
-** error that occurred should be given by the Application through an event message,
-** System Log entry, or both.
-** The request is recorded and the Executive Services App will actually delete
-** cFE Application before issuing this event message.
-**
-** The \c 's' field identifies the name of the Application that was exited.
-*/
+/**
+ * \brief ES Error Exit Application Complete Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * Error request to exit an application successfully completed.
+ * This event indicates the Application exited due to an error condition. The details of the
+ * error that occurred should be given by the Application through an event message,
+ * System Log entry, or both.
+ */
#define CFE_ES_ERREXIT_APP_INF_EID 14
-/** \brief 'Sent \%s application data'
-** \event 'Sent \%s application data'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is issued upon successful completion of the
-** cFE Executive Services \link #CFE_ES_QUERY_ONE_CC Query One Application command \endlink
-**
-** The \c 's' field identifies the name of the Application whose Executive Services
-** Application information has been telemetered.
-**/
+/**
+ * \brief ES Query One Application Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_QUERY_ONE_CC ES Query One Application Command \endlink success.
+ */
#define CFE_ES_ONE_APP_EID 15
-/** \brief 'App Info file written to \%s, Entries=\%d, FileSize=\%d'
-** \event 'App Info file written to \%s, Entries=\%d, FileSize=\%d'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is issued upon successful completion of the cFE Executive
-** Services \link #CFE_ES_QUERY_ALL_CC Query All Applications command \endlink
-**
-** The \c 's' field identifies the name of the file to which all Executive Services Application
-** data has been written. The \c Entries field identifies, in decimal, the number of Applications
-** whose data was written and the \c FileSize field gives the total number of bytes written to the
-** file.
-**/
+/**
+ * \brief ES Query All Applications Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_QUERY_ALL_CC ES Query All Applications Command \endlink success.
+ */
#define CFE_ES_ALL_APPS_EID 16
-/** \brief 'Cleared Executive Services log data'
-** \event 'Cleared Executive Services log data'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion of the cFE Executive
-** Services \link #CFE_ES_CLEAR_SYSLOG_CC Clear System Log command \endlink
-**/
+/**
+ * \brief ES Clear System Log Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_CLEAR_SYSLOG_CC ES Clear System Log Command \endlink success.
+ */
#define CFE_ES_SYSLOG1_INF_EID 17
-/** \brief '\%s written:Size=\%d,Entries=\%d'
-** \event '\%s written:Size=\%d,Entries=\%d'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated when the System Log has been successfully written
-** to a file after receiving the cFE Executive Services \link #CFE_ES_CLEAR_SYSLOG_CC Write Executive
-** Services System Log command \endlink
-**
-** The \c 's' field identifies the name of the file written to, the \c Size field specifies, in decimal,
-** the number of bytes written to the file and the \c Entries field identifies the number of System Log
-** messages that were written.
-**/
+/**
+ * \brief ES Write System Log Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_CLEAR_SYSLOG_CC ES Write System Log Command \endlink success.
+ */
#define CFE_ES_SYSLOG2_EID 18
-/** \brief 'Cleared mode log data'
-** \event 'Cleared mode log data'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion of the cFE Executive
-** Services \link #CFE_ES_CLEAR_ER_LOG_CC Clear Exception Reset Log command \endlink
-**/
+/**
+ * \brief ES Clear Exception Reset Log Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_CLEAR_ER_LOG_CC ES Clear Exception Reset Log Command \endlink success.
+ */
#define CFE_ES_ERLOG1_INF_EID 19
-/** \brief '\%s written:Size=\%d'
-** \event '\%s written:Size=\%d'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated when the Exception Reset Log has been successfully written
-** to a file after receiving the cFE Executive Services \link #CFE_ES_WRITE_ER_LOG_CC Write Executive
-** Services Exception Reset Log command \endlink
-**
-** The \c 's' field identifies the name of the file written to and the \c Size field specifies, in decimal,
-** the number of bytes written to the file.
-**/
+/**
+ * \brief ES Write Exception Reset Log Complete Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * Request to write the Exception Reset log successfully completed.
+ */
#define CFE_ES_ERLOG2_EID 20
-/** \brief 'Invalid command pipe message ID: 0x\%X'
-** \event 'Invalid command pipe message ID: 0x\%X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a message has arrived on
-** the cFE Executive Services Application's Message Pipe that has a
-** Message ID that is neither #CFE_ES_SEND_HK_MID or #CFE_ES_CMD_MID.
-** Most likely, the cFE Software Bus routing table has become corrupt
-** and is sending messages targeted for other Applications to the cFE
-** Executive Services Application.
-**
-** The \c ID field in the event message identifies
-** the message ID (in hex) that was found in the message.
-**/
-#define CFE_ES_MID_ERR_EID 21 /* invalid command packet "error" */
+/**
+ * \brief ES Invalid Message ID Received Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid message ID received on the ES message pipe.
+ */
+#define CFE_ES_MID_ERR_EID 21
-/** \brief 'Invalid ground command code: ID = 0x\%X, CC = \%d'
-** \event 'Invalid ground command code: ID = 0x\%X, CC = \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a message with the #CFE_ES_CMD_MID
-** message ID has arrived but whose Command Code is not one of the command
-** codes specified in \link #CFE_ES_NOOP_CC cfe_es.h \endlink. This
-** problem is most likely to occur when:
-** -# A Message ID meant for another Application became corrupted and was
-** set equal to #CFE_ES_CMD_MID.
-** -# The Command Code field in the Message became corrupted.
-** -# The command database at the ground station has been corrupted.
-**
-** The \c ID field in the event message specifies the Message ID (in hex) and the
-** \c CC field specifies the Command Code (in decimal) found in the message.
-**/
+/**
+ * \brief ES Invalid Command Code Received Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid command code for message ID #CFE_ES_CMD_MID received on the ES message pipe.
+ */
#define CFE_ES_CC1_ERR_EID 22
-/** \brief 'Invalid cmd length: ID = 0x\%X, CC = \%d, Exp Len = \%d, Len = \%d'
-** \event 'Invalid cmd length: ID = 0x\%X, CC = \%d, Exp Len = \%d, Len = \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a message with the #CFE_ES_CMD_MID
-** message ID has arrived but whose packet length does not match the expected
-** length for the specified command code.
-**
-** The \c ID field in the event message specifies the Message ID (in hex), the \c CC field
-** specifies the Command Code (in decimal), the \c Exp Len field specified the Expected
-** Length (in decimal ), and \c Len specifies the message Length (in decimal)
-** found in the message.
-**/
+/**
+ * \brief ES Invalid Command Length Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid length for the command code in message ID #CFE_ES_CMD_MID received on the ES message pipe.
+ */
#define CFE_ES_LEN_ERR_EID 23
-/** \brief 'Invalid cFE restart type \%d'
-** \event 'Invalid cFE restart type \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is issued when the cFE Executive Services receives a
-** \link #CFE_ES_RESTART_CC cFE Restart Command \endlink whose parameter
-** identifying the restart type is not equal to either #CFE_PSP_RST_TYPE_PROCESSOR
-** or #CFE_PSP_RST_TYPE_POWERON.
-**
-** The 'd' field identifies the numeric, in decimal, of the restart type found
-** in the received cFE Restart Command Packet.
-**/
-#define CFE_ES_BOOT_ERR_EID 24 /* command specific "error" */
+/**
+ * \brief ES Restart Command Invalid Restart Type Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_RESTART_CC ES cFE Restart Command \endlink failure due to invalid restart type.
+ */
+#define CFE_ES_BOOT_ERR_EID 24
-/** \brief 'Failed to start \%s from \%s, RC = \%08X'
-** \event 'Failed to start \%s from \%s, RC = \%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated for an error encountered in response
-** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink.
-**
-** This message is a general failure when the command passes the parameter validation, but
-** fails when a call to CFE_ES_AppCreate is called.
-**
-** The \c 's' term identifies the name of the Application that was attempted to start.
-** The second \c 's' field specifies the file from which the Application was loaded.
-** The \c 'X' field is the return code returned by the CFE_ES_AppCreate.
-**/
+/**
+ * \brief ES Start Application Command Application Creation Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_START_APP_CC ES Start Application Command \endlink failure during
+ * application creation after successful parameter validation.
+ */
#define CFE_ES_START_ERR_EID 26
-/** \brief 'CFE_ES_StartAppCmd: invalid filename: \%s'
-** \event 'CFE_ES_StartAppCmd: invalid filename: \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated for an error encountered in response
-** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink.
-**
-** This message reports a command failure when the Start Appplication Command is given
-** an invalid filename. ( Either NULL or too short to be a valid cFE file name ).
-**
-** The \c 's' term identifies the invalid filename that was sent with the command.
-**/
+/**
+ * \brief ES Start Application Command Invalid Filename Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_START_APP_CC ES Start Application Command \endlink falure due to
+ * invalid filename.
+ */
#define CFE_ES_START_INVALID_FILENAME_ERR_EID 27
-/** \brief 'CFE_ES_StartAppCmd: App Entry Point is NULL.'
-** \event 'CFE_ES_StartAppCmd: App Entry Point is NULL.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated for an error encountered in response
-** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink.
-**
-** This message reports a command failure when the Start Appplication Command is given
-** a NULL Application Entry Point parameter. The command must contain an application entry
-** point string. ( Example: "SC_AppMain" ).
-**
-**/
+/**
+ * \brief ES Start Application Command Entry Point NULL Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_START_APP_CC ES Start Application Command \endlink failure due to
+ * a NULL Application Entry Point.
+ */
#define CFE_ES_START_INVALID_ENTRY_POINT_ERR_EID 28
-/** \brief 'CFE_ES_StartAppCmd: App Name is NULL.'
-** \event 'CFE_ES_StartAppCmd: App Name is NULL.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated for an error encountered in response
-** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink.
-**
-** This message reports a command failure when the Start Appplication Command is given
-** a NULL Application Name parameter. The command must contain an application name string.
-**/
+/**
+ * \brief ES Start Application Command App Name NULL Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_START_APP_CC ES Start Application Command \endlink failure due to
+ * NULL Application Name.
+ */
#define CFE_ES_START_NULL_APP_NAME_ERR_EID 29
-/** \brief 'CFE_ES_StartAppCmd: Priority is too large: \%d.'
-** \event 'CFE_ES_StartAppCmd: Priority is too large: \%d.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated for an error encountered in response
-** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink.
-**
-** This message reports a command failure when the Application priority greater than the
-** maximum priority for a Task defined by the OS Abstraction Layer ( 256 ).
-**
-** The \c 'd' term identifies the priority that was given in the command.
-**/
+/**
+ * \brief ES Start Application Command Priority Too Large Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_START_APP_CC ES Start Application Command \endlink failure due to
+ * a requested application priority greater than the maximum priority allowed for tasks as
+ * defined by the OS Abstraction Layer (OS_MAX_PRIORITY).
+ */
#define CFE_ES_START_PRIORITY_ERR_EID 31
-/** \brief 'CFE_ES_StartAppCmd: Invalid Exception Action: \%d.'
-** \event 'CFE_ES_StartAppCmd: Invalid Exception Action: \%d.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated for an error encountered in response
-** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink.
-**
-** This message reports a command failure when the Application Exception Action parameter is
-** invalid. The valid options for this parameter are: 0 = Application will restart on an exception
-** 1 = Application cause a processor restart on
-** exception.
-**
-** The \c 'd' term identifies the Exception Action parameter that was given in the command.
-**/
+/**
+ * \brief ES Start Application Command Exception Action Invalid Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_START_APP_CC ES Start Application Command \endlink failure due to
+ * invalid application exception action.
+ */
#define CFE_ES_START_EXC_ACTION_ERR_EID 32
-/** \brief 'Exit Application \%s on Error Failed: CleanUpApp Error 0x\%08X.'
-** \event 'Exit Application \%s on Error Failed: CleanUpApp Error 0x\%08X.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when ES is completing the processing of the
-** CFE_ES_ExitApp API call with the CFE_ES_RunStatus_APP_ERROR parameter and the call to CFE_ES_CleanUpApp fails.
-** At this point the Application will likely be stopped or deleted, but it may be in an unknown state.
-**
-** The \c 's' field identifies the name of the Application which was attempted to be
-** reloaded and the \c RC field identifies the error code, in hex, that will identify
-** the precise reason for the failure.
-**/
+/**
+ * \brief ES Error Exit Application Cleanup Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Error request to exit an application failed during application cleanup.
+ * Application and related resources will be in undefined state.
+ */
#define CFE_ES_ERREXIT_APP_ERR_EID 33
-/** \brief 'Stop Application \%s Failed, RC = 0x\%08X'
-** \event 'Stop Application \%s Failed, RC = 0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated upon receipt of an Executive Services
-** \link #CFE_ES_STOP_APP_CC Stop Application Command \endlink which fails.
-**
-** The \c 's' field identifies the name of the Application which was attempted to be
-** stopped and the \c rc field identifies the error code, in hex, that may identify
-** the precise reason for the failure.
-**/
+/**
+ * \brief ES Stop Application Commmand Request Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_STOP_APP_CC ES Stop Application Command \endlink request failed.
+ */
#define CFE_ES_STOP_ERR1_EID 35
-/** \brief 'Stop Application \%s, GetAppIDByName failed. RC = 0x\%08X.'
-** \event 'Stop Application \%s, GetAppIDByName failed. RC = 0x\%08X.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated upon receipt of an Executive Services
-** \link #CFE_ES_STOP_APP_CC Stop Application Command \endlink which fails. This message
-** is for a specific failure when the call to CFE_ES_GetAppIDByName fails. The application
-** will not be deleted at this point.
-**
-** The \c 's' field identifies the name of the Application which was attempted to be
-** stopped and the \c RC field identifies the error code, in hex, that will identify
-** the precise reason for the failure.
-**/
+/**
+ * \brief ES Stop Application Command Get AppID By Name Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_STOP_APP_CC ES Stop Application Command \endlink failed to get application
+ * ID from application name. The application will not be deleted.
+ */
#define CFE_ES_STOP_ERR2_EID 36
-/*
-** "Stop Application \%s Failed: CleanUpApp Error 0x\%08X."
-*/
-
-/** \brief 'Stop Application \%s Failed: CleanUpApp Error 0x\%08X.'
-** \event 'Stop Application \%s Failed: CleanUpApp Error 0x\%08X.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated upon receipt of an Executive Services
-** \link #CFE_ES_STOP_APP_CC Stop Application Command \endlink which fails. This message
-** is for a specific failure when the call to CFE_ES_GetAppIDByName fails. The application
-** will not be deleted at this point.
-**
-** The \c 's' field identifies the name of the Application which was attempted to be
-** stopped and the \c RC field identifies the error code, in hex, that will identify
-** the precise reason for the failure.
-**/
+/**
+ * \brief ES Stop Application Cleanup Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Request to delete an application failed during application cleanup.
+ * Application and related resources will be in undefined state.
+ */
#define CFE_ES_STOP_ERR3_EID 37
-/** \brief 'Restart Application \%s Failed, RC = 0x\%08X'
-** \event 'Restart Application \%s Failed, RC = 0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services \link #CFE_ES_RESTART_APP_CC Restart Application
-** Command \endlink fails.
-**
-** The \c 's' field identifies the name of the Application which was attempted to be
-** reset and the \c rc field identifies the error code, in hex, that may identify
-** the precise reason for the failure.
-**/
+/**
+ * \brief ES Restart Application Command Request Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_RESTART_APP_CC ES Restart Application Command \endlink request failed.
+ */
#define CFE_ES_RESTART_APP_ERR1_EID 38
-/** \brief 'Restart Application \%s, GetAppIDByName failed. RC = 0x\%08X.'
-** \event 'Restart Application \%s, GetAppIDByName failed. RC = 0x\%08X.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated upon receipt of an Executive Services
-** \link #CFE_ES_RESTART_APP_CC Restart Application Command \endlink which fails. This message
-** is for a specific failure when the call to CFE_ES_GetAppIDByName fails. The application
-** will not be restarted at this point.
-**
-** The \c 's' field identifies the name of the Application which was attempted to be
-** restarted and the \c RC field identifies the error code, in hex, that will identify
-** the precise reason for the failure.
-**/
+/**
+ * \brief ES Restart Application Command Get AppID By Name Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_RESTART_APP_CC ES Restart Application Command \endlink failed to get application
+ * ID from application name. The application will not be restarted.
+ */
#define CFE_ES_RESTART_APP_ERR2_EID 39
-/*
-** "Restart Application \%s Failed: AppCreate Error 0x\%08X."
-*/
-
-/** \brief 'Restart Application \%s Failed: AppCreate Error 0x\%08X.'
-** \event 'Restart Application \%s Failed: AppCreate Error 0x\%08X.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated upon receipt of an Executive Services
-** \link #CFE_ES_RESTART_APP_CC Restart Application Command \endlink which fails. This message
-** is for a specific failure when the call to CFE_ES_AppCreate fails. The application
-** will not be restarted at this point.
-**
-** The \c 's' field identifies the name of the Application which was attempted to be
-** restarted and the \c RC field identifies the error code, in hex, that will identify
-** the precise reason for the failure.
-**/
+/**
+ * \brief ES Restart Application Startup Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Request to restart an application failed during application startup. The application
+ * will not be restarted.
+ */
#define CFE_ES_RESTART_APP_ERR3_EID 40
-/** \brief 'Restart Application \%s Failed: CleanUpApp Error 0x\%08X.'
-** \event 'Restart Application \%s Failed: CleanUpApp Error 0x\%08X.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated upon receipt of an Executive Services
-** \link #CFE_ES_RESTART_APP_CC Restart Application Command \endlink which fails. This message
-** is for a specific failure when the call to CFE_ES_CleanUpApp fails. The application
-** will not be restarted at this point, but will likely be deleted or in an unknown state.
-**
-** The \c 's' field identifies the name of the Application which was attempted to be
-** restarted and the \c RC field identifies the error code, in hex, that will identify
-** the precise reason for the failure.
-**/
+/**
+ * \brief ES Restart Application Cleanup Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Request to restart an application failed during application cleanup. The application
+ * will not be restarted and will be in an undefined state along with it's associated
+ * resources.
+ */
#define CFE_ES_RESTART_APP_ERR4_EID 41
-/** \brief 'Failed to reload Application \%s, rc = \%08X'
-** \event 'Failed to reload Application \%s, rc = \%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services \link #CFE_ES_RELOAD_APP_CC Reload Application
-** Command \endlink fails.
-**
-** The \c 's' field identifies the name of the Application which was attempted to be
-** reloaded and the \c rc field identifies the error code, in hex, that may identify
-** the precise reason for the failure.
-**/
+/**
+ * \brief ES Reload Application Command Request Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_RELOAD_APP_CC ES Reload Application Command \endlink request failed.
+ */
#define CFE_ES_RELOAD_APP_ERR1_EID 42
-/** \brief 'Reload Application \%s, GetAppIDByName failed. RC = 0x\%08X.'
-** \event 'Reload Application \%s, GetAppIDByName failed. RC = 0x\%08X.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated upon receipt of an Executive Services
-** \link #CFE_ES_RELOAD_APP_CC Reload Application Command \endlink which fails. This message
-** is for a specific failure when the call to CFE_ES_GetAppIDByName fails. The application
-** will not be reloaded at this point.
-**
-** The \c 's' field identifies the name of the Application which was attempted to be
-** reloaded and the \c RC field identifies the error code, in hex, that will identify
-** the precise reason for the failure.
-**/
+/**
+ * \brief ES Reload Application Command Get AppID By Name Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_RELOAD_APP_CC ES Reload Application Command \endlink failed to get application
+ * ID from application name. The application will not be reloaded.
+ */
#define CFE_ES_RELOAD_APP_ERR2_EID 43
-/** \brief 'Reload Application \%s Failed: AppCreate Error 0x\%08X.'
-** \event 'Reload Application \%s Failed: AppCreate Error 0x\%08X.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated upon receipt of an Executive Services
-** \link #CFE_ES_RELOAD_APP_CC Reload Application Command \endlink which fails. This message
-** is for a specific failure when the call to CFE_ES_AppCreate fails. The application
-** will not be reloaded at this point.
-**
-** The \c 's' field identifies the name of the Application which was attempted to be
-** reloaded and the \c RC field identifies the error code, in hex, that will identify
-** the precise reason for the failure.
-**/
+/**
+ * \brief ES Reload Application Startup Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Request to reload an application failed during application startup. The application
+ * will not be reloaded.
+ */
#define CFE_ES_RELOAD_APP_ERR3_EID 44
-/** \brief 'Reload Application \%s Failed: CleanUpApp Error 0x\%08X.'
-** \event 'Reload Application \%s Failed: CleanUpApp Error 0x\%08X.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated upon receipt of an Executive Services
-** \link #CFE_ES_RELOAD_APP_CC Reload Application Command \endlink which fails. This message
-** is for a specific failure when the call to CFE_ES_CleanUpApp fails. The application
-** will not be reloaded at this point, and will likely be deleted or in an unknown state.
-**
-** The \c 's' field identifies the name of the Application which was attempted to be
-** reloaded and the \c RC field identifies the error code, in hex, that will identify
-** the precise reason for the failure.
-**/
+/**
+ * \brief ES Reload Application Cleanup Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Request to reload an application failed during application cleanup. The application
+ * will not be reloaded and will be in an undefined state along with it's associated
+ * resources.
+ */
#define CFE_ES_RELOAD_APP_ERR4_EID 45
-/** \brief 'Exit Application \%s Failed: CleanUpApp Error 0x\%08X.'
-** \event 'Exit Application \%s Failed: CleanUpApp Error 0x\%08X.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when ES is completing the processing of the
-** CFE_ES_ExitApp API call and the call to CFE_ES_CleanUpApp fails. At this point the Application will
-** likely be stopped or deleted, but it may be in an unknown state.
-**
-** The \c 's' field identifies the name of the Application which was attempted to be
-** reloaded and the \c RC field identifies the error code, in hex, that will identify
-** the precise reason for the failure.
-**/
+/**
+ * \brief ES Exit Application Cleanup Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Nominal request to exit an application failed during application cleanup.
+ * Application and related resources will be in undefined state.
+ */
#define CFE_ES_EXIT_APP_ERR_EID 46
-/** \brief 'ES_ProcControlReq: Invalid State (EXCEPTION) Application \%s.'
-** \event 'ES_ProcControlReq: Invalid State (EXCEPTION) Application \%s.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when ES is processing it's internal Application table and encounters
-** an App with the EXCEPTION state. Because exceptions are supposed to be processed immediately, this is
-** an invalid state and should not happen. It may indicate some sort of memory corruption or other problem.
-**/
+/**
+ * \brief ES Process Control Invalid Exception State Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid Exception state encountered when processing requests for application state changes.
+ * Exceptions are processed immediately, so this state should never occur during routine processing.
+ */
#define CFE_ES_PCR_ERR1_EID 47
-/*
-** "CFE_ES_CleanUpApp: Unknown State ( \%d ) Application \%s."
-*/
-/** \brief 'ES_ProcControlReq: Unknown State ( \%d ) Application \%s.'
-** \event 'ES_ProcControlReq: Unknown State ( \%d ) Application \%s.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when ES is processing it's internal Application table and encounters
-** an App with an unknown state. If this message occurs, it might be an indication of a memory corruption
-** or other problem.
-**/
+/**
+ * \brief ES Process Control Unknown State Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Unknown state encountered when processing requests for application state changes.
+ */
#define CFE_ES_PCR_ERR2_EID 48
-/** \brief 'Failed to send \%s application data, RC = \%08X'
-** \event 'Failed to send \%s application data, RC = \%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services \link #CFE_ES_QUERY_ONE_CC Request Application
-** Data Command \endlink failed.
-**
-** The \c 's' field identifies the name of the Application whose data was attempted
-** to be telemetered and the \c rc field identifies the error code, in hex, that may identify
-** the precise reason for the failure.
-**/
+/**
+ * \brief ES Query One Application Data Command Transmit Message Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_QUERY_ONE_CC ES Query One Application Data Command \endlink failed during
+ * message transmission.
+ */
#define CFE_ES_ONE_ERR_EID 49
-/** \brief 'Failed to send \%s application data: GetAppIDByName Failed, RC = 0x\%08X'
-** \event 'Failed to send \%s application data: GetAppIDByName Failed, RC = 0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services \link #CFE_ES_QUERY_ONE_CC Request Application
-** Data Command \endlink failed.
-**
-** The \c 's' field identifies the name of the Application whose data was attempted
-** to be telemetered and the \c rc field identifies the error code, in hex, that may identify
-** the precise reason for the failure.
-**/
+/**
+ * \brief ES Query One Application Data Command Get AppID By Name Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_QUERY_ONE_CC ES Query One Application Data Command \endlink failed to get application
+ * ID from application name. Message will not be sent.
+ */
#define CFE_ES_ONE_APPID_ERR_EID 50
-/** \brief 'Failed to write App Info file, OS_OpenCreate returned \%d'
-** \event 'Failed to write App Info file, OS_OpenCreate returned \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services \link #CFE_ES_QUERY_ALL_CC Dump Application
-** Data Command \endlink fails to create the dump file.
-**
-** The \c 'd' parameter identifies, in decimal, the error code returned by #OS_OpenCreate when the attempt was made
-** to create the file.
-**/
+/**
+ * \brief ES Query All Application Data Command File Creation Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_QUERY_ALL_CC ES Query All Application Data Command \endlink failed to create file.
+ */
#define CFE_ES_OSCREATE_ERR_EID 51
-/** \brief 'Failed to write App Info file, WriteHdr rtnd \%08X, exp \%d'
-** \event 'Failed to write App Info file, WriteHdr rtnd \%08X, exp \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services \link #CFE_ES_QUERY_ALL_CC Dump Application
-** Data Command \endlink fails while writing the cFE Standard File Header.
-**
-** The \c rtnd field contains the error code returned by the #CFE_FS_WriteHeader API. Nominally, the
-** returned result should have been equal to the \c exp field (i.e. - sizeof(#CFE_FS_Header_t)).
-**/
+/**
+ * \brief ES Query All Application Data Command File Write Header Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_QUERY_ALL_CC ES Query All Application Data Command \endlink failed to write file header.
+ */
#define CFE_ES_WRHDR_ERR_EID 52
-/** \brief 'Failed to write App Info file, Task write RC = 0x\%08X, exp \%d'
-** \event 'Failed to write App Info file, Task write RC = 0x\%08X, exp \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever an Executive Services \link #CFE_ES_QUERY_ALL_CC Dump Application
-** Data Command \endlink fails while writing Application data to the specified file.
-**
-** The \c rtnd field contains, in hex, the error code returned from the #OS_write API. The expected return
-** value is identified, in decimal, in the \c exp field.
-**/
+/**
+ * \brief ES Query All Application Data Command File Write App Data Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_QUERY_ALL_CC ES Query All Application Data Command \endlink failed to write file application data.
+ */
#define CFE_ES_TASKWR_ERR_EID 53
-/** \brief 'Error creating file \%s, stat=0x\%x'
-** \event 'Error creating file \%s, stat=0x\%x'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services \link #CFE_ES_WRITE_SYSLOG_CC Dump System Log
-** Command \endlink fails while attempting to create the specified file.
-**
-** The \c 's' field identifies the name of the file that was attempted to be created and the \c stat field
-** specifies, in hex, the error code returned by the #OS_OpenCreate API.
-**/
+/**
+ * \brief ES Write System Log Command Filename Parse or File Creation Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_WRITE_SYSLOG_CC ES Write System Log Command \endlink failed parsing file
+ * name or creating the file. OVERLOADED
+ */
#define CFE_ES_SYSLOG2_ERR_EID 55
-/** \brief 'Error creating file \%s, stat=0x\%x'
-** \event 'Error creating file \%s, stat=0x\%x'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services \link #CFE_ES_WRITE_ER_LOG_CC Dump Exception Reset Log
-** Command \endlink fails while attempting to create the specified file.
-**
-** The \c 's' field identifies the name of the file that was attempted to be created and the \c stat field
-** specifies, in hex, the error code returned by the #OS_OpenCreate API.
-**/
+/**
+ * \brief ES Write Exception Reset Log Command Request or File Creation Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_WRITE_ER_LOG_CC ES Write Exception Reset Log Command \endlink request failed or
+ * file creation failed. OVERLOADED
+ */
#define CFE_ES_ERLOG2_ERR_EID 56
-/** \brief 'Start collecting performance data command, trigger mode = %d'
-** \event 'Start collecting performance data command, trigger mode = %d'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated in response to receiving an Executive Services
-** \link #CFE_ES_START_PERF_DATA_CC Start Performance Analyzer Data Collection Command \endlink
-**
-** The \c 'd' field identifies the requested trigger mode as defined by CFE_ES_PerfMode_t.
-**/
+/**
+ * \brief ES Start Performance Analyzer Data Collection Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_START_PERF_DATA_CC ES Start Performance Analyzer Data Collection Command \endlink success.
+ */
#define CFE_ES_PERF_STARTCMD_EID 57
-/** \brief 'Cannot start collecting performance data,perf data write in progress'
-** \event 'Cannot start collecting performance data,perf data write in progress'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated in response to receiving an Executive Services
-** \link #CFE_ES_START_PERF_DATA_CC Start Performance Analyzer Data Collection Command \endlink
-**/
+/**
+ * \brief ES Start Performance Analyzer Data Collection Command Idle Check Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_START_PERF_DATA_CC ES Start Performance Analyzer Data Collection Command \endlink failed
+ * due to already being started.
+ */
#define CFE_ES_PERF_STARTCMD_ERR_EID 58
-/** \brief 'Cannot start collecting performance data, trigger mode (%d) out of range (%d to %d)'
-** \event 'Cannot start collecting performance data, trigger mode (%d) out of range (%d to %d)'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services \link #CFE_ES_START_PERF_DATA_CC
-** Start Performance Analyzer Data Collection Command \endlink command is received with a bad
-** value for the requested trigger mode.
-**
-** The first \c 'd' field identifies the received trigger mode value as defined by CFE_ES_PerfMode_t.
-** The second and third \c 'd' fields specify the valid range of values for the trigger mode.
-**/
+/**
+ * \brief ES Start Performance Analyzer Data Collection Command Invalid Trigger Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_START_PERF_DATA_CC ES Start Performance Analyzer Data Collection Command \endlink failed
+ * due to invalid trigger mode.
+ */
#define CFE_ES_PERF_STARTCMD_TRIG_ERR_EID 59
-/** \brief 'Perf Stop Cmd Rcvd,\%s will write \%d entries.\%dmS dly every \%d entries'
-** \event 'Perf Stop Cmd Rcvd,\%s will write \%d entries.\%dmS dly every \%d entries'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon receipt of a successful Performance Data Stop
-** Command after receiving the cFE Executive Services \link #CFE_ES_STOP_PERF_DATA_CC Stop
-** Performance Analyzer Data Collection Command \endlink
-**
-** The \c 's' field identifies the name of the file write task that has begun execution.
-** The first \c 'd' identifies the total number of performance entries(in decimal) that will be written to the file.
-** A performance data entry is defined by an unsigned 32 bit data point and an unsigned 64 bit time stamp.
-** The second \c 'd' identifies the millisecond delay between writes and the
-** third \c 'd' identifies the number of entries written (in decimal) between delays.
-**/
+/**
+ * \brief ES Stop Performance Analyzer Data Collection Command Request Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_STOP_PERF_DATA_CC ES Stop Performance Analyzer Data Collection Command \endlink success.
+ * Note this event signifies the request to stop and write the performance data has been successfully
+ * submitted. The successful completion will generate a #CFE_ES_PERF_DATAWRITTEN_EID event.
+ */
#define CFE_ES_PERF_STOPCMD_EID 60
-/** \brief 'Stop performance data cmd ignored,perf data write in progress'
-** \event 'Stop performance data cmd ignored,perf data write in progress'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated upon receipt of an unsuccessful Performance Data Stop
-** Command after receiving the cFE Executive Services \link #CFE_ES_STOP_PERF_DATA_CC Stop
-** Performance Analyzer Data Collection Command \endlink
-**
-**/
+/**
+ * \brief ES Stop Performance Analyzer Data Collection Command Request Idle Check Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_STOP_PERF_DATA_CC ES Stop Performance Analyzer Data Collection Command \endlink failed
+ * due to a write already in progress.
+ */
#define CFE_ES_PERF_STOPCMD_ERR2_EID 62
-/** \brief 'Set Performance Filter Mask command'
-** \event 'Set Performance Filter Mask command'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated in response to receiving an Executive Services
-** \link #CFE_ES_SET_PERF_FILTER_MASK_CC Set Performance Analyzer Filter Mask Command \endlink.
-**
-**/
+/**
+ * \brief ES Set Performance Analyzer Filter Mask Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_SET_PERF_FILTER_MASK_CC ES Set Performance Analyzer Filter Mask Command \endlink success.
+ */
#define CFE_ES_PERF_FILTMSKCMD_EID 63
-/** \brief 'Performance Filter Mask Cmd Error,Index(%u)out of range(%u)'
-** \event 'Performance Filter Mask Cmd Error,Index(%u)out of range(%u)'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated in response to receiving an Executive Services
-** \link #CFE_ES_SET_PERF_FILTER_MASK_CC Set Performance Analyzer Filter Mask Command \endlink.
-**
-**/
+/**
+ * \brief ES Set Performance Analyzer Filter Mask Command Invalid Index Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_SET_PERF_FILTER_MASK_CC ES Set Performance Analyzer Filter Mask Command \endlink failed
+ * filter index range check.
+ */
#define CFE_ES_PERF_FILTMSKERR_EID 64
-/** \brief 'Set Performance Trigger Mask command'
-** \event 'Set Performance Trigger Mask command'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated in response to receiving an Executive Services
-** \link #CFE_ES_SET_PERF_TRIGGER_MASK_CC Set Performance Analyzer Trigger Mask Command \endlink.
-**
-**/
+/**
+ * \brief ES Set Performance Analyzer Trigger Mask Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_SET_PERF_TRIGGER_MASK_CC ES Set Performance Analyzer Trigger Mask Command \endlink success.
+ */
#define CFE_ES_PERF_TRIGMSKCMD_EID 65
-/** \brief 'Performance Trigger Mask Cmd Error,Index(%u)out of range(%u)'
-** \event 'Performance Trigger Mask Cmd Error,Index(%u)out of range(%u)'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated in response to receiving an Executive Services
-** \link #CFE_ES_SET_PERF_TRIGGER_MASK_CC Set Performance Analyzer Trigger Mask Command \endlink.
-**
-**/
+/**
+ * \brief ES Set Performance Analyzer Trigger Mask Command Invalid Mask Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_SET_PERF_TRIGGER_MASK_CC ES Set Performance Analyzer Trigger Mask Command \endlink failed
+ * the mask range check.
+ */
#define CFE_ES_PERF_TRIGMSKERR_EID 66
-/** \brief 'Error creating file \%s, stat=\%d'
-** \event 'Error creating file \%s, stat=\%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services
-** \link #CFE_ES_STOP_PERF_DATA_CC Stop Performance Analyzer Data Collection Command \endlink
-** fails to create the associated logic analyzer dump file.
-**
-** The \c 's' field identifies the name of the file that was attempted to be created and the \c stat field
-** specifies, in decimal, the error code returned by the #OS_OpenCreate API.
-**/
+/**
+ * \brief ES Stop Performance Analyzer Data Collection Command Filename Parse or File Create Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_STOP_PERF_DATA_CC ES Stop Performance Analyzer Data Collection Command \endlink failed
+ * either parsing the file name or during open/creation of the file. OVERLOADED
+ */
#define CFE_ES_PERF_LOG_ERR_EID 67
-/** \brief '\%s written:Size=\%d,EntryCount=\%d'
-** \event '\%s written:Size=\%d,EntryCount=\%d'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated when the Performance Log has been successfully written
-** to a file after receiving the cFE Executive Services \link #CFE_ES_STOP_PERF_DATA_CC Stop
-** Performance Analyzer Data Collection Command \endlink
-**
-** The \c 's' field identifies the name of the file written to, the \c Size field specifies, in decimal,
-** the number of bytes written to the file and the \c EntryCount field identifies the number of data
-** entries that were written.
-**/
+/**
+ * \brief Performance Log Write Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * Request to write the performance log successfully completed.
+ */
#define CFE_ES_PERF_DATAWRITTEN_EID 68
-/** \brief '\%s Failed to Register CDS '\%s', Status=0x\%08X'
-** \event '\%s Failed to Register CDS '\%s', Status=0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever an Application calls the #CFE_ES_RegisterCDS API and
-** fails to successfully create the desired CDS.
-**
-** The first \c 's' field identifies the name of the Application which made the API call, the second
-** \c 's' field specifies the name of the CDS as requested by the Application and the \c Status field
-** provides the error code which identifies in more detail the nature of the failure (See return codes
-** for the #CFE_ES_RegisterCDS API).
-**/
+/**
+ * \brief ES Register CDS API Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_ES_RegisterCDS API failure, see reported status code or system log for details.
+ */
#define CFE_ES_CDS_REGISTER_ERR_EID 69
-/** \brief 'Set OverWriteSysLog Command Received with Mode setting = \%d'
-** \event 'Set OverWriteSysLog Command Received with Mode setting = \%d'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion of an Executive Services \link
-*#CFE_ES_OVER_WRITE_SYSLOG_CC
-** Set System Log Overwrite Mode Command \endlink.
-**
-** The \c setting field identifies the newly chosen Overwrite Mode and should be equal to either
-** #CFE_ES_LogMode_OVERWRITE or #CFE_ES_LogMode_DISCARD.
-**/
+/**
+ * \brief ES Set System Log Overwrite Mode Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_OVER_WRITE_SYSLOG_CC ES Set System Log Overwrite Mode Command \endlink success.
+ */
#define CFE_ES_SYSLOGMODE_EID 70
-/** \brief 'Set OverWriteSysLog Command: Invalid Mode setting = \%d'
-** \event 'Set OverWriteSysLog Command: Invalid Mode setting = \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated upon unsuccessful completion of an Executive Services \link
-*#CFE_ES_OVER_WRITE_SYSLOG_CC
-** Set System Log Overwrite Mode Command \endlink.
-**
-** The \c setting field identifies the illegal Overwrite Mode found in the command message. The mode
-** must be either #CFE_ES_LogMode_OVERWRITE (0) or #CFE_ES_LogMode_DISCARD (1).
-**/
+/**
+ * \brief ES Set System Log Overwrite Mode Command Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_OVER_WRITE_SYSLOG_CC ES Set System Log Overwrite Mode Command \endlink failed
+ * due to invalid mode requested.
+ */
#define CFE_ES_ERR_SYSLOGMODE_EID 71
-/** \brief 'Reset Processor Reset Count to Zero'
-** \event 'Reset Processor Reset Count to Zero'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always generated in response to the Executive Services
-** \link #CFE_ES_RESET_PR_COUNT_CC Set Processor Reset Counter to Zero Command \endlink.
-**/
+/**
+ * \brief ES Set Processor Reset Counter to Zero Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_RESET_PR_COUNT_CC ES Set Processor Reset Counter to Zero Command \endlink success.
+ */
#define CFE_ES_RESET_PR_COUNT_EID 72
-/** \brief 'Maximum Processor Reset Count set to: \%d'
-** \event 'Maximum Processor Reset Count set to: \%d'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always generated in response to the Executive Services
-** \link #CFE_ES_RESET_PR_COUNT_CC Set Maximum Processor Reset Limit Command \endlink.
-**
-** The \c 'd' field identifies, in decimal, the number of Processor Resets that will need
-** to occur before a Power-On Reset is automatically performed.
-**/
+/**
+ * \brief ES Set Maximum Processor Reset Limit Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_RESET_PR_COUNT_CC ES Set Maximum Processor Reset Limit Command \endlink success.
+ */
#define CFE_ES_SET_MAX_PR_COUNT_EID 73
-/** \brief 'File write,byte cnt err,file \%s,request=\%d,actual=\%d'
-** \event 'File write,byte cnt err,file \%s,request=\%d,actual=\%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated in response to any command requesting information to be written
-** to a file and whose data is not completely written to the specified file.
-**
-** The \c file field identifies the filename of the file to which the data failed to write completely,
-** the \c request field specifies, in decimal, the number of bytes that were attempted to be written and
-** the \c actual field indicates, in decimal, the actual number of bytes written to the file.
-**/
+/**
+ * \brief ES File Write Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * ES File Write failure writing data to file. OVERLOADED
+ */
#define CFE_ES_FILEWRITE_ERR_EID 74
-/** \brief 'Error while deleting '\%s' from CDS, See SysLog.(Err=0x\%08X)'
-** \event 'Error while deleting '\%s' from CDS, See SysLog.(Err=0x\%08X)'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services
-** \link #CFE_ES_DELETE_CDS_CC Delete CDS Command \endlink
-** fails to cleanly remove the specified CDS.
-**
-** The \c 's' field identifies the name of the CDS that was attempted to be deleted the \c Err field
-** specifies, in hex, the error code.
-**/
+/**
+ * \brief ES Delete CDS Command Delete Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_DELETE_CDS_CC ES Delete CDS Command \endlink failed while deleting,
+ * see reported status code or system log for details.
+ */
#define CFE_ES_CDS_DELETE_ERR_EID 76
-/** \brief 'Unable to locate '\%s' in CDS Registry'
-** \event 'Unable to locate '\%s' in CDS Registry'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services
-** \link #CFE_ES_DELETE_CDS_CC Delete CDS Command \endlink
-** specifies a name for a CDS that cannot be found in the CDS Registry.
-**
-** The \c 's' field identifies the name of the CDS that was attempted to be deleted.
-**/
+/**
+ * \brief ES Delete CDS Command Lookup CDS Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_DELETE_CDS_CC ES Delete CDS Command \endlink failed due to the
+ * specified CDS name not found in the CDS Registry.
+ */
#define CFE_ES_CDS_NAME_ERR_EID 77
-/** \brief 'Successfully removed '\%s' from CDS'
-** \event 'Successfully removed '\%s' from CDS'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services
-** \link #CFE_ES_DELETE_CDS_CC Delete CDS Command \endlink
-** is successfully completed.
-**
-** The \c 's' field identifies the name of the CDS that was deleted.
-**/
+/**
+ * \brief ES Delete CDS Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_DELETE_CDS_CC ES Delete CDS Command \endlink success.
+ */
#define CFE_ES_CDS_DELETED_INFO_EID 78
-/** \brief 'CDS '\%s' is a Critical Table CDS. Must be deleted via TBL Command'
-** \event 'CDS '\%s' is a Critical Table CDS. Must be deleted via TBL Command'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services
-** \link #CFE_ES_DELETE_CDS_CC Delete CDS Command \endlink
-** specifies a name for a CDS that is a Critical Table image.
-** Critical Table images can only be deleted via a Table Services
-** command (#CFE_TBL_DELETE_CDS_CC).
-**
-** The \c 's' field identifies the name of the CDS that was attempted to be deleted.
-**/
+/**
+ * \brief ES Delete CDS Command For Critical Table Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_DELETE_CDS_CC Delete CDS Command \endlink failure due to the
+ * specified CDS name being a critical table.
+ * Critical Table images can only be deleted via a Table Services
+ * command, #CFE_TBL_DELETE_CDS_CC.
+ */
#define CFE_ES_CDS_DELETE_TBL_ERR_EID 79
-/** \brief 'CDS '\%s' not deleted because owning app is active'
-** \event 'CDS '\%s' not deleted because owning app is active'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services
-** \link #CFE_ES_DELETE_CDS_CC Delete CDS Command \endlink
-** specifies a name for a CDS whose prefix name identifies
-** an application that is still registered in the system.
-** CDSs can only be deleted when their owning applications
-** have been removed from the system.
-**
-** The \c 's' field identifies the name of the CDS that was attempted to be deleted.
-**/
+/**
+ * \brief ES Delete CDS Command With Active Owner Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_DELETE_CDS_CC ES Delete CDS Command \endlink failure due to the
+ * specifies CDS name is registered to an active application.
+ */
#define CFE_ES_CDS_OWNER_ACTIVE_EID 80
-/** \brief 'Successfully telemetered memory pool stats for 0x\%08X'
-** \event 'Successfully telemetered memory pool stats for 0x\%08X'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated following successful execution of the
-** \link #CFE_ES_SEND_MEM_POOL_STATS_CC Telemeter Memory Statistics Command \endlink.
-**/
+/**
+ * \brief ES Telemeter Memory Statistics Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_SEND_MEM_POOL_STATS_CC ES Telemeter Memory Statistics Command \endlink success.
+ */
#define CFE_ES_TLM_POOL_STATS_INFO_EID 81
-/** \brief 'Cannot telemeter memory pool stats. Illegal Handle (0x\%08X)'
-** \event 'Cannot telemeter memory pool stats. Illegal Handle (0x\%08X)'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services
-** \link #CFE_ES_SEND_MEM_POOL_STATS_CC Telemeter Memory Statistics Command \endlink
-** specifies a memory pool handle that is invalid. A handle is determined to
-** be invalid when any of the following are true:
-** -# The handle does not contain a value that is an integral multiple of 4
-** -# The handle does not specify a valid area of memory
-** -# The handle does not point to an area of memory that contains the handle itself
-** -# The handle does not point to an area of memory whose Size field is an integral multiple of 4
-** -# The handle does not point to an area of memory whose End field is equal to the Start plus the Size
-**
-** The \c '08X' field identifies the handle that was found in the command.
-**/
+/**
+ * \brief ES Telemeter Memory Statistics Command Invalid Handle Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_SEND_MEM_POOL_STATS_CC ES Telemeter Memory Statistics Command \endlink failure
+ * due to an invalid memory handle.
+ */
#define CFE_ES_INVALID_POOL_HANDLE_ERR_EID 82
-/** \brief 'Successfully dumped CDS Registry to '\%s':Size=\%d,Entries=\%d'
-** \event 'Successfully dumped CDS Registry to '\%s':Size=\%d,Entries=\%d'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services
-** \link #CFE_ES_DUMP_CDS_REGISTRY_CC Dump Critical Data Store Registry Command \endlink
-** is successfully executed. The specified file should have been created
-** and contains the CDS Registry Entries.
-**
-** The \c 's' field identifies the CDS Registry Dump Filename.
-** The first \c 'd' field specifies the size of the file (in bytes)
-** The second \c 'd' field specifies the number of CDS Registry Records that were written
-**/
+/**
+ * \brief ES Write Critical Data Store Registry Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_DUMP_CDS_REGISTRY_CC ES Write Critical Data Store Registry Command \endlink success.
+ */
#define CFE_ES_CDS_REG_DUMP_INF_EID 83
-/** \brief 'Error writing CDS Registry to '\%s', Status=0x\%08X'
-** \event 'Error writing CDS Registry to '\%s', Status=0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services
-** \link #CFE_ES_DUMP_CDS_REGISTRY_CC Dump Critical Data Store Registry Command \endlink
-** was being performed and it encountered a filesystem write error while writing
-** a CDS Registry record.
-**
-** The \c 's' field identifies the CDS Registry Dump Filename.
-** The \c '08X' field identifies the error code returned from #OS_write that caused the command to abort.
-**/
+/**
+ * \brief ES Write Critical Data Store Registry Command Record Write Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_DUMP_CDS_REGISTRY_CC ES Write Critical Data Store Registry Command \endlink failed
+ * to write CDS record.
+ */
#define CFE_ES_CDS_DUMP_ERR_EID 84
-/** \brief 'Error writing cFE File Header to '\%s', Status=0x\%08X'
-** \event 'Error writing cFE File Header to '\%s', Status=0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services
-** \link #CFE_ES_DUMP_CDS_REGISTRY_CC Dump Critical Data Store Registry Command \endlink
-** command successfully created the CDS Dump File onboard but encountered an error
-** while writing the standard cFE File Header to the file.
-**
-** The \c 's' field identifies the CDS Registry Dump Filename.
-** The \c '08X' field identifies error code returned by the API #CFE_FS_WriteHeader.
-**/
+/**
+ * \brief ES Write Critical Data Store Registry Command Header Write Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_DUMP_CDS_REGISTRY_CC ES Write Critical Data Store Registry Command \endlink failed
+ * to write header.
+ */
#define CFE_ES_WRITE_CFE_HDR_ERR_EID 85
-/** \brief 'Error creating CDS dump file '\%s', Status=0x\%08X'
-** \event 'Error creating CDS dump file '\%s', Status=0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services
-** \link #CFE_ES_DUMP_CDS_REGISTRY_CC Dump Critical Data Store Registry Command \endlink
-** is unable to create the specified file on the onboard filesystem.
-**
-** The \c 's' field identifies the CDS Registry Dump Filename.
-** The \c '08X' field identifies error code returned by the API #OS_OpenCreate.
-**/
+/**
+ * \brief ES Write Critical Data Store Registry Command Filename Parse or File Create Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_DUMP_CDS_REGISTRY_CC ES Write Critical Data Store Registry Command \endlink failed
+ * to parse filename or open/create the file. OVERLOADED
+ */
#define CFE_ES_CREATING_CDS_DUMP_ERR_EID 86
-/** \brief 'Task Info file written to \%s, Entries=\%d, FileSize=\%d'
-** \event 'Task Info file written to \%s, Entries=\%d, FileSize=\%d'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is issued upon successful completion of the cFE Executive
-** Services \link #CFE_ES_QUERY_ALL_TASKS_CC Query All Tasks command \endlink
-**
-** The \c 's' field identifies the name of the file to which all Executive Services Task
-** data has been written. The \c Entries field identifies, in decimal, the number of Tasks
-** whose data was written and the \c FileSize field gives the total number of bytes written to the
-** file.
-**/
+/**
+ * \brief ES Write All Task Data Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_QUERY_ALL_TASKS_CC ES Write All Task Data Command \endlink success.
+ */
#define CFE_ES_TASKINFO_EID 87
-/** \brief 'Failed to write Task Info file, OS_OpenCreate returned \%d'
-** \event 'Failed to write Task Info file, OS_OpenCreate returned \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services \link #CFE_ES_QUERY_ALL_TASKS_CC Dump Task
-** Data Command \endlink fails to create the dump file.
-**
-** The \c 'd' parameter identifies, in decimal, the error code returned by #OS_OpenCreate when the attempt was made
-** to create the file.
-**/
+/**
+ * \brief ES Write All Task Data Command Filename Parse or File Create Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_QUERY_ALL_TASKS_CC ES Write All Task Data Command \endlink failed
+ * to parse the filename or open/create the file.
+ */
#define CFE_ES_TASKINFO_OSCREATE_ERR_EID 88
-/** \brief 'Failed to write Task Info file, WriteHdr rtnd \%08X, exp \%d'
-** \event 'Failed to write Task Info file, WriteHdr rtnd \%08X, exp \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services \link #CFE_ES_QUERY_ALL_TASKS_CC Dump Task
-** Data Command \endlink fails while writing the cFE Standard File Header.
-**
-** The \c rtnd field contains the error code returned by the #CFE_FS_WriteHeader API. Nominally, the
-** returned result should have been equal to the \c exp field (i.e. - sizeof(#CFE_FS_Header_t)).
-**/
+/**
+ * \brief ES Write All Task Data Command Write Header Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_QUERY_ALL_TASKS_CC ES Write All Task Data Command \endlink failed
+ * to write file header.
+ */
#define CFE_ES_TASKINFO_WRHDR_ERR_EID 89
-/** \brief 'Failed to write Task Info file, Task write RC = 0x\%08X, exp \%d'
-** \event 'Failed to write Task Info file, Task write RC = 0x\%08X, exp \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever an Executive Services \link #CFE_ES_QUERY_ALL_TASKS_CC Dump Tasks
-** Data Command \endlink fails while writing Tasks data to the specified file.
-**
-** The \c rtnd field contains, in hex, the error code returned from the #OS_write API. The expected return
-** value is identified, in decimal, in the \c exp field.
-**/
+/**
+ * \brief ES Write All Task Data Command Write Data Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_QUERY_ALL_TASKS_CC ES Write All Task Data Command \endlink failed
+ * to write task data to file.
+ */
#define CFE_ES_TASKINFO_WR_ERR_EID 90
-/** \brief 'Version Info: %s, %s'
-** \event 'Version Info: %s, %s'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always automatically issued when the Executive Services
-** Task completes its Initialization and as part of the Noop command
-**
-** A separate version info event will be generated for every module which is statically
-** linked into the CFE core executable (e.g. OSAL, PSP, MSG, SBR, etc).
-**
-** The version information reported in this event is derived from the source revision
-** control system at build time, as opposed to manually-assigned semantic version numbers.
-** It is intendended to uniquely identify the actual source code that is currently running,
-** to the extent this is possible.
-**
-** The \c Mission version information also identifies the build configuration name, if available.
-**/
+/**
+ * \brief cFS Version Information Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * ES Initialization complete and response to \link #CFE_ES_NOOP_CC ES NO-OP Command \endlink.
+ *
+ * A separate version info event will be generated for every module which is statically
+ * linked into the CFE core executable (e.g. OSAL, PSP, MSG, SBR, etc).
+ *
+ * The version information reported in this event is derived from the source revision
+ * control system at build time, as opposed to manually-assigned semantic version numbers.
+ * It is intendended to uniquely identify the actual source code that is currently running,
+ * to the extent this is possible.
+ *
+ * The \c Mission version information also identifies the build configuration name, if available.
+ */
#define CFE_ES_VERSION_INF_EID 91
-/** \brief 'Build %s by %s@%s, config %s'
-** \event 'Build %s by %s@%s, config %s'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always automatically issued when the Executive Services
-** Task completes its Initialization, and as part of the Noop command.
-**
-** The \c Build field identifies the build date, time, hostname and user identifier of
-** the build host machine for the current running binary. The first string is the
-** build date/time, and the second string is formatted as "user@hostname"
-**
-** This additionally reports the configuration name that was selected by the user,
-** which may affect various platform/mission limits.
-**
-** By default, if not specified/overridden, the default values of these variables will be:
-** BUILDDATE ==> the output of "date +%Y%m%d%H%M"
-** HOSTNAME ==> the output of "hostname"
-** USER ==> the output of "whoami"
-**
-** The values can be overridden by setting an environment variable with the names above
-** to the value desired for the field when running "make".
-**/
+/**
+ * \brief cFS Build Information Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * ES Initialization complete and response to \link #CFE_ES_NOOP_CC ES NO-OP Command \endlink.
+ *
+ * The \c Build field identifies the build date, time, hostname and user identifier of
+ * the build host machine for the current running binary. The first string is the
+ * build date/time, and the second string is formatted as "user@hostname"
+ *
+ * This additionally reports the configuration name that was selected by the user,
+ * which may affect various platform/mission limits.
+ *
+ * By default, if not specified/overridden, the default values of these variables will be:
+ * BUILDDATE ==> the output of "date +%Y%m%d%H%M"
+ * HOSTNAME ==> the output of "hostname"
+ * USER ==> the output of "whoami"
+ *
+ * The values can be overridden by setting an environment variable with the names above
+ * to the value desired for the field when running "make".
+ */
#define CFE_ES_BUILD_INF_EID 92
-/** \brief 'Error log write to file \%s already in progress'
-** \event 'Error log write to file \%s already in progress'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Executive Services \link #CFE_ES_WRITE_ER_LOG_CC Dump Exception Reset Log
-** Command \endlink is received before a previously-issued command has finished executing
-**
-**/
+/**
+ * \brief ES Write Exception Reset Log Command Already In Progress Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_ES_WRITE_ER_LOG_CC ES Write Exception Reset Log Command \endlink failure due to
+ * a write already being in progress.
+ */
#define CFE_ES_ERLOG_PENDING_ERR_EID 93
+/**\}*/
#endif /* CFE_ES_EVENTS_H */
diff --git a/modules/evs/fsw/inc/cfe_evs_events.h b/modules/evs/fsw/inc/cfe_evs_events.h
index 3bbf54a0d..753260131 100644
--- a/modules/evs/fsw/inc/cfe_evs_events.h
+++ b/modules/evs/fsw/inc/cfe_evs_events.h
@@ -21,622 +21,453 @@
/**
* @file
*
- * Purpose:
- * cFE Event Services (EVS) Event IDs
- *
- * Design Notes:
- *
- * References:
- * Flight Software Branch C Coding Standard Version 1.0a
- *
+ * cFE Event Services Event IDs
*/
#ifndef CFE_EVS_EVENTS_H
#define CFE_EVS_EVENTS_H
-/* **************************
-** ****** Maximum EID. ******
-** **************************
-** The EID's below may not necessarily be in order, so it can be difficult to
-** determine what the next EID is to use. When you add EID's, start with MAX_EID + 1
-** and when you're done adding, set this to the highest EID you used. It may
-** be worthwhile to, on occasion, re-number the EID's to put them back in order.
-*/
-#define CFE_EVS_MAX_EID 43
-
-/* Event Service event ID's */
+/**
+ * \name EVS event IDs
+ */
+/**\{*/
-/** \brief 'No-op command'
-** \event 'No-op command'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always automatically issued in response
-** to a cFE Event Services \link #CFE_EVS_NOOP_CC NO-OP command \endlink
-**/
-#define CFE_EVS_NOOP_EID 0 /* Noop event identifier */
+/**
+ * \brief EVS No-op Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_NOOP_CC EVS NO-OP command \endlink success.
+ */
+#define CFE_EVS_NOOP_EID 0
-/** \brief 'cFE EVS Initialized'
-** \event 'cFE EVS Initialized'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always automatically issued when the Event Services
-** Task completes its Initialization.
-**/
+/**
+ * \brief EVS Initialization Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * Event Services Task initialization complete.
+ */
#define CFE_EVS_STARTUP_EID 1
-/** \brief 'Write Log File Command Error: OS_write = 0x\%08X, filename = \%s'
-** \event 'Write Log File Command Error: OS_write = 0x\%08X, filename = \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a filesystem error occurred while writing the contents of the
-** event message log to a file.
-**
-** The message text identifies the event log filename and specifies the return value, in hex,
-** from the system function call. The expected return value is the number of bytes written,
-** which in this case should be equal to the size of a #CFE_EVS_LongEventTlm_t structure. Error
-** codes are negative.
-**/
+/**
+ * \brief EVS Write Event Log Command File Write Entry Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_WRITE_LOG_DATA_FILE_CC EVS Write Event Log Command \endlink failure
+ * writing data to the file.
+ */
#define CFE_EVS_ERR_WRLOGFILE_EID 2
-/** \brief 'Write Log File Command Error: OS_OpenCreate = 0x\%08X, filename = \%s'
-** \event 'Write Log File Command Error: OS_OpenCreate = 0x\%08X, filename = \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a filesystem error occurred when attempting to create the file
-** that is to hold the event message log.
-**
-** The message text identifies the event log filename and specifies the return value, in hex,
-** from the system function call. The expected return value is a file handle, which in this case
-** should be a relatively small positive number. Error codes are negative.
-**/
+/**
+ * \brief EVS Write Event Log Command Filename Parse or File Create Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_WRITE_LOG_DATA_FILE_CC EVS Write Event Log Command \endlink failure
+ * parsing the file name or during open/creation of the file. OVERLOADED
+ */
#define CFE_EVS_ERR_CRLOGFILE_EID 3
-/** \brief 'Invalid command packet, Message ID = 0x\%08X'
-** \event 'Invalid command packet, Message ID = 0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a message has arrived on
-** the cFE Event Services Application's Message Pipe that has a
-** Message ID that is neither #CFE_EVS_CMD_MID or #CFE_EVS_SEND_HK_MID.
-** Most likely, the cFE Software Bus routing table has become corrupt
-** and is sending messages targeted for other Applications to the cFE
-** Event Services Application.
-**
-** The \c ID field in the event message identifies
-** the message ID (in hex) that was found in the message.
-**/
+/**
+ * \brief EVS Invalid Message ID Received Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid message ID received on the EVS message pipe.
+ */
#define CFE_EVS_ERR_MSGID_EID 5
-/** \brief '\%s Event ID \%d not registered for filtering: CC = \%lu'
-** \event '\%s Event ID \%d not registered for filtering: CC = \%lu'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when the specified command identifies an Application and Event ID combination
-** that is not found in the Events Registry.
-**
-** The \c \%s string contains the command specified Application Name the \c Event \c ID field
-** identifies the command specified EventID (in decimal) that was not found in the Events Registry.
-** The \c CC field specifies the Command Code whose processing generated the event message. It can
-** be equal to either #CFE_EVS_SET_FILTER_CC, #CFE_EVS_RESET_FILTER_CC, or #CFE_EVS_DELETE_EVENT_FILTER_CC.
-**/
+/**
+ * \brief EVS Command Event Not Registered For Filtering Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An EVS command handler failure due to the event not being registered for filtering. OVERLOADED
+ */
#define CFE_EVS_ERR_EVTIDNOREGS_EID 6
-/** \brief '\%s not registered with EVS: CC = \%lu'
-** \event '\%s not registered with EVS: CC = \%lu'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when the specified command identifies an Application that has not been
-** registered with the cFE Event Services.
-**
-** The \c CC field contains the Command Code whose processing resulted in the generation of the event message.
-** Possible values are #CFE_EVS_SET_FILTER_CC, #CFE_EVS_ENABLE_APP_EVENT_TYPE_CC, #CFE_EVS_DISABLE_APP_EVENT_TYPE_CC,
-** #CFE_EVS_ENABLE_APP_EVENTS_CC, #CFE_EVS_DISABLE_APP_EVENTS_CC, #CFE_EVS_RESET_APP_COUNTER_CC,
-*#CFE_EVS_RESET_FILTER_CC,
-** #CFE_EVS_RESET_ALL_FILTERS_CC, #CFE_EVS_ADD_EVENT_FILTER_CC, or #CFE_EVS_DELETE_EVENT_FILTER_CC.
-**/
+/**
+ * \brief EVS Command Application Not Registered With EVS Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An EVS command handler failure due to the referenced application not being registered with EVS. OVERLOADED
+ */
#define CFE_EVS_ERR_APPNOREGS_EID 7
-/** \brief 'Illegal application ID \%d retrieved for \%s: CC = \%lu'
-** \event 'Illegal application ID \%d retrieved for \%s: CC = \%lu'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when the specified command identifies an Application whose name is
-** found in the Events Registry but does not appear to be properly registered with the cFE Executive Services.
-**
-** The \c CC field contains the Command Code whose processing resulted in the generation of the event message.
-** Possible values are #CFE_EVS_SET_FILTER_CC, #CFE_EVS_ENABLE_APP_EVENT_TYPE_CC, #CFE_EVS_DISABLE_APP_EVENT_TYPE_CC,
-** #CFE_EVS_ENABLE_APP_EVENTS_CC, #CFE_EVS_DISABLE_APP_EVENTS_CC, #CFE_EVS_RESET_APP_COUNTER_CC,
-*#CFE_EVS_RESET_FILTER_CC,
-** #CFE_EVS_RESET_ALL_FILTERS_CC, #CFE_EVS_ADD_EVENT_FILTER_CC, or #CFE_EVS_DELETE_EVENT_FILTER_CC.
-**/
+/**
+ * \brief EVS Command Get Application Data Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An EVS command handler failure retreiving the application data. OVERLOADED
+ */
#define CFE_EVS_ERR_ILLAPPIDRANGE_EID 8
-/** \brief 'Unable to retrieve application ID for \%s: CC = \%lu'
-** \event 'Unable to retrieve application ID for \%s: CC = \%lu'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when the specified command contains an Application name that is
-** apparently found in the Events Registry but does not appear to be registered with the cFE Executive Services.
-**
-** The \c CC field contains the Command Code whose processing resulted in the generation of the event message.
-** Possible values are #CFE_EVS_SET_FILTER_CC, #CFE_EVS_ENABLE_APP_EVENT_TYPE_CC, #CFE_EVS_DISABLE_APP_EVENT_TYPE_CC,
-** #CFE_EVS_ENABLE_APP_EVENTS_CC, #CFE_EVS_DISABLE_APP_EVENTS_CC, #CFE_EVS_RESET_APP_COUNTER_CC,
-*#CFE_EVS_RESET_FILTER_CC,
-** #CFE_EVS_RESET_ALL_FILTERS_CC, #CFE_EVS_ADD_EVENT_FILTER_CC, or #CFE_EVS_DELETE_EVENT_FILTER_CC.
-**/
+/**
+ * \brief EVS Command Get Application ID Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An EVS command handler failure retreiving the application ID. OVERLOADED
+ */
#define CFE_EVS_ERR_NOAPPIDFOUND_EID 9
-/** \brief 'Set Event Format Mode Command: Invalid Event Format Mode = 0x\%02x'
-** \event 'Set Event Format Mode Command: Invalid Event Format Mode = 0x\%02x'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a "Set Event Format Mode" command
-** message has arrived and the #CFE_EVS_SetLogMode_Payload_t::LogMode field is equal to
-** neither #CFE_EVS_MsgFormat_SHORT or #CFE_EVS_MsgFormat_LONG. These are
-** the only allowed values for the mode field.
-**
-** The \c Mode field in the event message identifies
-** the Mode value (in hex) that was found in the message.
-**/
+/**
+ * \brief EVS Set Event Format Command Invalid Format Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_SET_EVENT_FORMAT_MODE_CC EVS Set Event Format Command \endlink failure
+ * due to invalid format argument.
+ */
#define CFE_EVS_ERR_ILLEGALFMTMOD_EID 10
-/** \brief 'Add Filter Command: number of registered filters has reached max = \%d'
-** \event 'Add Filter Command: number of registered filters has reached max = \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated upon receipt of an "Add Filter" command
-** and the specified Application has already reached the maximum number of
-** filters allowed (#CFE_PLATFORM_EVS_MAX_EVENT_FILTERS).
-**
-** The \c max field in the event message identifies the maximum number of
-** event filters allowed per Application. This value should be equal to
-** the configuration parameter #CFE_PLATFORM_EVS_MAX_EVENT_FILTERS.
-**/
+/**
+ * \brief EVS Add Filter Command Max Filters Exceeded Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_ADD_EVENT_FILTER_CC EVS Add Filter Command \endlink failure
+ * due to exceeding the maximum number of filters.
+ */
#define CFE_EVS_ERR_MAXREGSFILTER_EID 11
-/** \brief 'Write App Data Command Error: OS_write = 0x\%08X, filename = \%s'
-** \event 'Write App Data Command Error: OS_write = 0x\%08X, filename = \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a filesystem error occurred while writing the contents of the
-** event registry to a file.
-**
-** The message text identifies the registry filename and specifies the return value, in hex,
-** from the system function call. The expected return value is the number of bytes written,
-** which in this case should be equal to the size of a CFE_EVS_AppDataFile_t structure. Error
-** codes are negative.
-**/
+/**
+ * \brief EVS Write Application Data Command Write Data Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_WRITE_APP_DATA_FILE_CC Write Application Data Command \endlink failure
+ * to write application EVS data.
+ */
#define CFE_EVS_ERR_WRDATFILE_EID 12
-/** \brief 'Write App Data Command Error: OS_OpenCreate = 0x\%08X, filename = \%s'
-** \event 'Write App Data Command Error: OS_OpenCreate = 0x\%08X, filename = \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a filesystem error occurred when attempting to create the file
-** that is to hold the event registry data.
-**
-** The message text identifies the registry filename and specifies the return value, in hex,
-** from the system function call. The expected return value is a file handle, which in this case
-** should be a relatively small positive number. Error codes are negative.
-**/
+/**
+ * \brief EVS Write Application Data Command Filename Parse or File Create Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_WRITE_APP_DATA_FILE_CC Write Application Data Command \endlink failed
+ * to parse the filename or open/create the file. OVERLOADED
+ */
#define CFE_EVS_ERR_CRDATFILE_EID 13
-/** \brief 'Invalid command code -- ID = 0x\%08x, CC = \%d'
-** \event 'Invalid command code -- ID = 0x\%08x, CC = \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a message with the #CFE_EVS_CMD_MID
-** message ID has arrived but whose Command Code is not one of the specified
-** accepted command codes specified. This problem is most likely to occur when:
-** -# A Message ID meant for another Application became corrupted and was
-** set equal to #CFE_EVS_CMD_MID.
-** -# The Command Code field in the Message became corrupted.
-** -# The command database at the ground station has been corrupted.
-**
-** The \c ID field in the event message specifies the Message ID (in hex) and the
-** \c CC field specifies the Command Code (in decimal) found in the message.
-**/
+/**
+ * \brief EVS Invalid Command Code Received Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid command code for message ID #CFE_EVS_CMD_MID received on the EVS message pipe.
+ */
#define CFE_EVS_ERR_CC_EID 15
-/** \brief 'Reset Counters Command Received'
-** \event 'Reset Counters Command Received'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is always automatically issued in response
-** to a cFE Event Services Reset Counters command
-**/
+/**
+ * \brief EVS Reset Counters Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_RESET_COUNTERS_CC EVS Reset Counters Command \endlink success.
+ */
#define CFE_EVS_RSTCNT_EID 16
-/** \brief 'Set Filter Mask Command Received with AppName=\%s, EventID=0x\%08x, Mask=0x\%04x'
-** \event 'Set Filter Mask Command Received with AppName=\%s, EventID=0x\%08x, Mask=0x\%04x'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is issued upon successful processing of a Set Filter Mask command.
-**
-** The \c AppName field identifies the Application whose Filter Mask has been changed.
-** The \c EventID field identifies the Event whose Filter Mask has been changed.
-** The \c Mask field identifies the new Mask value associated with the specified event.
-**/
+/**
+ * \brief EVS Set Filter Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_SET_FILTER_CC EVS Set Filter Command \endlink success.
+ */
#define CFE_EVS_SETFILTERMSK_EID 17
-/** \brief 'Enable Ports Command Received with Port Bit Mask = 0x\%02x'
-** \event 'Enable Ports Command Received with Port Bit Mask = 0x\%02x'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is issued upon successful processing of the "Enable Ports" command.
-**
-** The \c Mask field identifies the ports that are enabled.
-** Mask bits are defined by #CFE_EVS_PORT1_BIT, #CFE_EVS_PORT2_BIT, #CFE_EVS_PORT3_BIT and #CFE_EVS_PORT4_BIT.
-**/
+/**
+ * \brief EVS Enable Ports Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_ENABLE_PORTS_CC EVS Enable Ports Command \endlink success.
+ */
#define CFE_EVS_ENAPORT_EID 18
-/** \brief 'Disable Ports Command Received with Port Bit Mask = 0x\%02x'
-** \event 'Disable Ports Command Received with Port Bit Mask = 0x\%02x'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is issued upon successful processing of the "Disable Ports" command.
-**
-** The \c Mask field identifies (in hex) the ports are to be disabled.
-** Mask bits are defined by #CFE_EVS_PORT1_BIT, #CFE_EVS_PORT2_BIT, #CFE_EVS_PORT3_BIT and #CFE_EVS_PORT4_BIT.
-**/
+/**
+ * \brief EVS Disable Ports Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_DISABLE_PORTS_CC EVS Disable Ports Command \endlink success.
+ */
#define CFE_EVS_DISPORT_EID 19
-/** \brief 'Enable Event Type Command Received with Event Type Bit Mask = 0x\%02x'
-** \event 'Enable Event Type Command Received with Event Type Bit Mask = 0x\%02x'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is issued upon successful processing of the "Enable Event Type" command.
-**
-** The \c Mask field identifies the Event Types that are enabled.
-** Mask bits are defined by #CFE_EVS_DEBUG_BIT, #CFE_EVS_INFORMATION_BIT,
-** #CFE_EVS_ERROR_BIT and #CFE_EVS_CRITICAL_BIT.
-**/
+/**
+ * \brief EVS Enable Event Type Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_ENABLE_EVENT_TYPE_CC EVS Enable Event Type Command \endlink success.
+ */
#define CFE_EVS_ENAEVTTYPE_EID 20
-/** \brief 'Disable Event Type Command Received with Event Type Bit Mask = 0x\%02x'
-** \event 'Disable Event Type Command Received with Event Type Bit Mask = 0x\%02x'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is issued upon successful processing of the "Disable Event Type" command.
-**
-** The \c Mask field identifies the Event Types that are disabled.
-** Mask bits are defined by #CFE_EVS_DEBUG_BIT, #CFE_EVS_INFORMATION_BIT,
-** #CFE_EVS_ERROR_BIT and #CFE_EVS_CRITICAL_BIT.
-**/
+/**
+ * \brief EVS Disable Event Type Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_DISABLE_EVENT_TYPE_CC EVS Disable Event Type Command \endlink success.
+ */
#define CFE_EVS_DISEVTTYPE_EID 21
-/** \brief 'Set Event Format Mode Command Received with Mode = 0x\%02x'
-** \event 'Set Event Format Mode Command Received with Mode = 0x\%02x'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion of the "Set Event Format Mode" command.
-**
-** The \c Mode field contains the newly chosen Event Format Mode (specified in hex). Acceptable values
-** for this parameter are: #CFE_EVS_MsgFormat_SHORT or #CFE_EVS_MsgFormat_LONG
-**/
+/**
+ * \brief EVS Set Event Format Mode Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_SET_EVENT_FORMAT_MODE_CC EVS Set Event Format Mode Command \endlink success.
+ */
#define CFE_EVS_SETEVTFMTMOD_EID 22
-/** \brief 'Enable App Event Type Command Received with AppName = \%s, EventType Bit Mask = 0x\%02x'
-** \event 'Enable App Event Type Command Received with AppName = \%s, EventType Bit Mask = 0x\%02x'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion of the "Enable Application Event Types" command.
-**
-** The \c AppName field identifies the Application whose Event Type Enable status has changed and the
-** \c Mask field specifies (in hex) the Event Types that have been enabled.
-** Mask bits are defined by #CFE_EVS_DEBUG_BIT, #CFE_EVS_INFORMATION_BIT,
-** #CFE_EVS_ERROR_BIT and #CFE_EVS_CRITICAL_BIT.
-**/
+/**
+ * \brief EVS Enable App Event Type Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_ENABLE_APP_EVENT_TYPE_CC EVS Enable App Event Type Command \endlink success.
+ */
#define CFE_EVS_ENAAPPEVTTYPE_EID 23
-/** \brief 'Disable App Event Type Command Received with AppName = \%s, EventType Bit Mask = 0x\%02x'
-** \event 'Disable App Event Type Command Received with AppName = \%s, EventType Bit Mask = 0x\%02x'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion of the "Disable Application Event Types" command.
-**
-** The \c AppName field identifies the Application whose Event Type Disable status has changed and the
-** \c Mask field specifies (in hex) the Event Types that have been disabled.
-** Mask bits are defined by #CFE_EVS_DEBUG_BIT, #CFE_EVS_INFORMATION_BIT,
-** #CFE_EVS_ERROR_BIT and #CFE_EVS_CRITICAL_BIT.
-**/
+/**
+ * \brief EVS Disable App Event Type Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_DISABLE_APP_EVENT_TYPE_CC EVS Disable App Event Type Command \endlink success.
+ */
#define CFE_EVS_DISAPPENTTYPE_EID 24
-/** \brief 'Enable App Events Command Received with AppName = \%s'
-** \event 'Enable App Events Command Received with AppName = \%s'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion of the "Enable Application Events" command.
-**
-** The \c AppName field identifies the Application whose Events have been Enabled.
-**/
+/**
+ * \brief EVS Enable App Events Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_ENABLE_APP_EVENTS_CC EVS Enable App Events Command \endlink success.
+ */
#define CFE_EVS_ENAAPPEVT_EID 25
-/** \brief 'Disable App Events Command Received with AppName = \%s'
-** \event 'Disable App Events Command Received with AppName = \%s'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion of the "Disable Application Events" command.
-**
-** The \c AppName field identifies the Application whose Events have been Disabled.
-**/
+/**
+ * \brief EVS Disable App Events Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_DISABLE_APP_EVENTS_CC EVS Disable App Events Command \endlink success.
+ */
#define CFE_EVS_DISAPPEVT_EID 26
-/** \brief 'Reset Event Counter Command Received with AppName = \%s'
-** \event 'Reset Event Counter Command Received with AppName = \%s'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion of the "Reset Application Event Counter" command.
-**
-** The \c AppName field identifies the Application whose Event Counter has been reset.
-**/
+/**
+ * \brief EVS Reset App Event Counter Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_RESET_APP_COUNTER_CC EVS Reset App Event Counter Command \endlink success.
+ */
#define CFE_EVS_RSTEVTCNT_EID 27
-/** \brief 'Reset Filter Command Received with AppName = \%s, EventID = 0x\%08x'
-** \event 'Reset Filter Command Received with AppName = \%s, EventID = 0x\%08x'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion of the "Reset Application Event Message Filter" command.
-**
-** The \c AppName field identifies the Application whose Event Message Filter has been reset and
-** the \c EventID field identifies the specific event message whose filter has been reset.
-**/
+/**
+ * \brief EVS Reset App Event Filter Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_RESET_FILTER_CC EVS Reset App Event Filter Command \endlink success.
+ */
#define CFE_EVS_RSTFILTER_EID 28
-/** \brief 'Reset All Filters Command Received with AppName = \%s'
-** \event 'Reset All Filters Command Received with AppName = \%s'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion of the "Reset Application Event Message Filters" command.
-**
-** The \c AppName field identifies the Application whose entire set of Event Filters has been reset.
-**/
+/**
+ * \brief EVS Reset All Filters Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_RESET_ALL_FILTERS_CC EVS Reset All FIlters Command \endlink success.
+ */
#define CFE_EVS_RSTALLFILTER_EID 29
-/** \brief 'Add Filter Command Received with AppName = \%s, EventID = 0x\%08x, Mask = 0x\%04x'
-** \event 'Add Filter Command Received with AppName = \%s, EventID = 0x\%08x, Mask = 0x\%04x'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion of the "Add Filter" command.
-**
-** The \c AppName field identifies the Application who is getting the new filter, the \c EventID field
-** identifies the Event Identifier, in hex, that is getting the filter, and the \c Mask field specifies, in hex,
-** what the binary filter mask has been set to.
-**/
+/**
+ * \brief EVS Add Event Filter Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_ADD_EVENT_FILTER_CC EVS Add Event Filter Command \endlink success.
+ */
#define CFE_EVS_ADDFILTER_EID 30
-/** \brief 'Delete Filter Command Received with AppName = \%s, EventID = 0x\%08x'
-** \event 'Delete Filter Command Received with AppName = \%s, EventID = 0x\%08x'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion of the "Delete Filter" command.
-**
-** The \c AppName field identifies the Application who is getting the filter removed, the \c EventID field
-** identifies the Event Identifier, in hex, whose filter is being deleted.
-**/
+/**
+ * \brief EVS Delete Event Filter Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_DELETE_EVENT_FILTER_CC EVS Delete Event Filter Command \endlink success.
+ */
#define CFE_EVS_DELFILTER_EID 31
-/** \brief 'Write App Data Command: \%d application data entries written to \%s'
-** \event 'Write App Data Command: \%d application data entries written to \%s'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion of the
-** \link #CFE_EVS_WRITE_APP_DATA_FILE_CC "Write Event Services Application Information to File" \endlink command.
-**
-** The message text identifies the event log filename and specifies the number, in decimal,
-** of events written to the file.
-**/
+/**
+ * \brief EVS Write Application Data Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_WRITE_APP_DATA_FILE_CC EVS Write Application Data Command \endlink success.
+ */
#define CFE_EVS_WRDAT_EID 32
-/** \brief 'Write Log File Command: \%d event log entries written to \%s'
-** \event 'Write Log File Command: \%d event log entries written to \%s'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion of the
-** \link #CFE_EVS_WRITE_LOG_DATA_FILE_CC "Write Event Log to File" \endlink command.
-**
-** The message text identifies the event log filename and specifies the number, in decimal,
-** of events written to the file.
-**/
+/**
+ * \brief EVS Write Event Log Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_WRITE_LOG_DATA_FILE_CC EVS Write Event Log Command \endlink success.
+ */
#define CFE_EVS_WRLOG_EID 33
-/** \brief 'Add Filter Command:AppName = \%s, EventID = 0x\%08x is already registered for filtering'
-** \event 'Add Filter Command:AppName = \%s, EventID = 0x\%08x is already registered for filtering'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an "Add Filter" command was received specifying an Event ID that has already
-** had a filter added.
-**
-** The \c AppName field identifies the Application whose filter was to be added and the \c EventID field identifies,
-** in hex, the Event ID that the command was trying to add a filter for.
-**/
+/**
+ * \brief EVS Add Filter Command Duplicate Registration Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_ADD_EVENT_FILTER_CC EVS Add Filter Command \endlink failure due
+ * to event already being registered for filtering.
+ */
#define CFE_EVS_EVT_FILTERED_EID 37
-/** \brief 'Set Log Mode Command Error: Log Mode = \%d'
-** \event 'Set Log Mode Command Error: Log Mode = \%d'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated when a "Set Log Mode" command is completed successfully.
-**
-** The event text identifies the Log Mode command argument. Valid Log Mode command
-** arguments are: #CFE_EVS_LogMode_OVERWRITE or #CFE_EVS_LogMode_DISCARD.
-**/
+/**
+ * \brief EVS Set Log Mode Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_SET_LOG_MODE_CC EVS Set Log Mode Command \endlink success.
+ */
#define CFE_EVS_LOGMODE_EID 38
-/** \brief 'Set Log Mode Command Error: Log Mode = \%d'
-** \event 'Set Log Mode Command Error: Log Mode = \%d
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a "Set Log Mode" command is received that specifies
-** an invalid Log Mode command argument.
-**
-** The event text identifies the invalid Log Mode command argument. Valid Log Mode command
-** arguments are: #CFE_EVS_LogMode_OVERWRITE or #CFE_EVS_LogMode_DISCARD.
-**/
+/**
+ * \brief EVS Set Log Mode Command Invalid Mode Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_EVS_SET_LOG_MODE_CC EVS Set Log Mode Command \endlink failure
+ * due to invalid log mode.
+ */
#define CFE_EVS_ERR_LOGMODE_EID 39
-/** \brief 'Bit Mask = 0x\%X out of range: CC = \%lu'
-** \event 'Bit Mask = 0x\%X out of range: CC = \%lu'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when the bit mask passed in is equal to zero or greater than 0x0F, because a
-** bit mask of zero does nothing, and a bitmask of greater than 0x0F is invalid.
-**/
+/**
+ * \brief EVS Port Or Event Type Bitmask Invalid Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid bitmask for EVS port or event type. OVERLOADED
+ */
#define CFE_EVS_ERR_INVALID_BITMASK_EID 40
-/** \brief 'App \%s not registered with Event Services. Unable to send event'
-** \event 'App \%s not registered with Event Services. Unable to send event'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an event message has been requested to be sent by an Application that
-** has not registered itself with cFE Event Services.
-**/
+/**
+ * \brief EVS Send Event API App Not Registered With EVS Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An EVS Send Event API called for application not registered with EVS.
+ */
#define CFE_EVS_ERR_UNREGISTERED_EVS_APP 41
-/** \brief 'Max filter count reached, AppName = \%s, EventID = 0x\%08x: Filter locked until reset'
-** \event 'Max filter count reached, AppName = \%s, EventID = 0x\%08x: Filter locked until reset'
-**
-** \par Type: INFORMATIONAL
-**
-** \par Cause:
-**
-** This event message is generated when the filtering count for a specific App and Event ID reaches
-** CFE_EVS_MAX_FILTER_COUNT. The filtered event will no longer be received until the reset counter is reset via a
-** \link #CFE_EVS_RESET_FILTER_CC "Reset an Event Filter for an Application" \endlink or a
-** \link #CFE_EVS_RESET_ALL_FILTERS_CC "Reset All Event Filters for an Application" \endlink
-**
-** The \c AppName field identifies the Application and the \c EventID field identifies, in hex, the Event ID
-** for the filter whose maxium was reached.
-**/
+/**
+ * \brief EVS Filter Max Count Reached Event ID
+ *
+ * \par Type: INFORMATIONAL
+ *
+ * \par Cause:
+ *
+ * Filter count for the event reached CFE_EVS_MAX_FILTER_COUNT and is latched until filter is reset.
+ */
#define CFE_EVS_FILTER_MAX_EID 42
-/** \brief 'Invalid cmd length: ID = 0x\%X, CC = \%d, Exp Len = \%d, Len = \%d'
-** \event 'Invalid cmd length: ID = 0x\%X, CC = \%d, Exp Len = \%d, Len = \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a message with the #CFE_EVS_CMD_MID
-** message ID has arrived but whose packet length does not match the expected
-** length for the specified command code.
-**
-** The \c ID field in the event message specifies the Message ID (in hex), the \c CC field
-** specifies the Command Code (in decimal), the \c Exp Len field specified the Expected
-** Length (in decimal ), and \c Len specifies the message Length (in decimal)
-** found in the message.
-**/
+/**
+ * \brief EVS Invalid Command Length Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid length for the command code in message ID #CFE_EVS_CMD_MID received on the EVS message pipe.
+ */
#define CFE_EVS_LEN_ERR_EID 43
+/**\}*/
#endif /* CFE_EVS_EVENTS_H */
diff --git a/modules/sb/fsw/inc/cfe_sb_events.h b/modules/sb/fsw/inc/cfe_sb_events.h
index 682b3fe35..f175ead5d 100644
--- a/modules/sb/fsw/inc/cfe_sb_events.h
+++ b/modules/sb/fsw/inc/cfe_sb_events.h
@@ -21,886 +21,746 @@
/**
* @file
*
- * Purpose:
- * cFE Software Bus (SB) Event IDs
- *
- * References:
- * Flight Software Branch C Coding Standard Version 1.0a
- * cFE Flight Software Application Developers Guide
- *
+ * cFE Software Bus Services Event IDs
*/
#ifndef CFE_SB_EVENTS_H
#define CFE_SB_EVENTS_H
-/* **************************
-** ****** Maximum EID. ******
-** **************************
-** The EID's below are not necessarily in order, so it can be difficult to
-** determine what the next EID is to use. When you add EID's, start with MAX_EID + 1
-** and when you're done adding, set this to the highest EID you used. It may
-** be worthwhile to, on occasion, re-number the EID's to put them back in order.
-*/
-#define CFE_SB_MAX_EID 67
-
-/*
-** SB task event message ID's.
-*/
-/*
-** Event ID's
-*/
+/**
+ * \name SB event IDs
+ */
+/**\{*/
-/** \brief 'cFE SB Initialized'
-** \event 'cFE SB Initialized'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is issued when the Software Bus Task completes its
-** initialization.
-**/
+/**
+ * \brief SB Initialization Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * Software Bus Services Task initialization complete.
+ */
#define CFE_SB_INIT_EID 1
-/** \brief 'CreatePipeErr:Bad Input Arg:app=\%s,ptr=0x\%x,depth=\%d,maxdepth=\%d'
-** \event 'CreatePipeErr:Bad Input Arg:app=\%s,ptr=0x\%x,depth=\%d,maxdepth=\%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the #CFE_SB_CreatePipe API receives a bad
-** argument. In this case, a bad argument is defined by the following:
-** A NULL PipeIdPtr, PipeDepth = 0 and PipeDepth > maximum pipe depth
-**/
+/**
+ * \brief SB Create Pipe API Bad Argument Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_CreatePipe API failure due to a bad input argument.
+ */
#define CFE_SB_CR_PIPE_BAD_ARG_EID 2
-/** \brief 'CreatePipeErr:Max Pipes(\%d)In Use.app \%s'
-** \event 'CreatePipeErr:Max Pipes(\%d)In Use.app \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the #CFE_SB_CreatePipe API is called and
-** the maximum number of pipes (defined by cfg param #CFE_PLATFORM_SB_MAX_PIPES) are in use.
-**/
+/**
+ * \brief SB Create Pipe API Max Pipes Exceeded Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_CreatePipe API failure to do maximum number of pipes being exceeded.
+ */
#define CFE_SB_MAX_PIPES_MET_EID 3
-/** \brief 'CreatePipeErr:OS_QueueCreate returned \%d,app \%s'
-** \event 'CreatePipeErr:OS_QueueCreate returned \%d,app \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the #CFE_SB_CreatePipe API is called and
-** the OS returns an error when the OS returns an error from the OS_QueueCreate API.
-** The error status returned by the OS is displayed in the event. Most commonly,
-** this event is displayed as a result of trying to create pipes with the same name.
-**/
+/**
+ * \brief SB Create Pipe API Queue Create Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_CreatePipe API failure creating the queue.
+ */
#define CFE_SB_CR_PIPE_ERR_EID 4
-/** \brief 'Pipe Created:name \%s,id \%d,app \%s'
-** \event 'Pipe Created:name \%s,id \%d,app \%s'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This debug event message is issued when a pipe was successfully created in the
-** #CFE_SB_CreatePipe API.
-**/
+/**
+ * \brief SB Create Pipe API Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_CreatePipe API successfully completed.
+ */
#define CFE_SB_PIPE_ADDED_EID 5
-/** \brief 'SetPipeOptsErr:Invalid pipe id (\%d).app \%s'
-** \event 'SetPipeOptsErr:Invalid pipe id (\%d).app \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the #CFE_SB_SetPipeOpts API is called and
-** the PipeID is invalid.
-**/
-#define CFE_SB_SETPIPEOPTS_ID_ERR_EID 55
-
-/** \brief 'SetPipeOptsErr:Caller not owner (\%d).app \%s'
-** \event 'SetPipeOptsErr:Caller not owner (\%d).app \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the #CFE_SB_SetPipeOpts API is called and
-** the pipe is owned by another app ID.
-**/
-#define CFE_SB_SETPIPEOPTS_OWNER_ERR_EID 56
-
-/** \brief 'SetPipeOpts: Options set (\%d). app \%s'
-** \event 'SetPipeOpts: Options set (\%d). app \%s'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This debug event is generated when options are set.
-**/
-#define CFE_SB_SETPIPEOPTS_EID 57
-
-/** \brief 'GetPipeOptsErr:Invalid pipe id (\%d).app \%s'
-** \event 'GetPipeOptsErr:Invalid pipe id (\%d).app \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the #CFE_SB_GetPipeOpts API is called and
-** the PipeID is invalid.
-**/
-#define CFE_SB_GETPIPEOPTS_ID_ERR_EID 58
-
-/** \brief 'GetPipeOptsErr:Invalid opts ptr.app \%s'
-** \event 'GetPipeOptsErr:Invalid opts ptr.app \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the #CFE_SB_GetPipeOpts API is called and
-** the pointer is invalid.
-**/
-#define CFE_SB_GETPIPEOPTS_PTR_ERR_EID 59
-
-/** \brief 'GetPipeOpts: Options retrieved. app \%s'
-** \event 'GetPipeOpts: Options retrieved. app \%s'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This debug event is generated when options are retrieved.
-**/
-#define CFE_SB_GETPIPEOPTS_EID 60
-
-/** \brief 'GetPipeName: Name retrieved. NameOut \%s,Id \%d, app \%s'
-** \event 'GetPipeName: Name retrieved. NameOut \%s,Id \%d, app \%s'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This debug event is generated when name is retrieved by id.
-**/
-#define CFE_SB_GETPIPENAME_EID 62
-
-/** \brief 'GetPipeName: Null ptr error. Id \%d, app \%s'
-** \event 'GetPipeName: Null ptr error. Id \%d, app \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This debug event is generated when the name buffer ptr is null.
-**/
-#define CFE_SB_GETPIPENAME_NULL_PTR_EID 63
-
-/** \brief 'GetPipeName: Id error. NameOut \%s,Id \%d, app \%s'
-** \event 'GetPipeName: Id error. NameOut \%s,Id \%d, app \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This debug event is generated when name is retrieved by id.
-**/
-#define CFE_SB_GETPIPENAME_ID_ERR_EID 64
-
-/** \brief 'GetPipeIdByName: ID retrieved. Name \%s,IdOut 0x\%x, app \%s'
-** \event 'GetPipeIdByName: ID retrieved. Name \%s,IdOut 0x\%x, app \%s'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This debug event is generated when id is retrieved by name.
-**/
-#define CFE_SB_GETPIPEIDBYNAME_EID 65
-
-/** \brief 'GetPipeIdByName Err:Bad input argument,Name 0x\%x,IdOut 0x%x,App \%s'
-** \event 'GetPipeIdByName Err:Bad input argument,Name 0x\%x,IdOut 0x%x,App \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the #CFE_SB_GetPipeIdByName API receives a
-** NULL ptr as an argument.
-**/
-#define CFE_SB_GETPIPEIDBYNAME_NULL_ERR_EID 66
-
-/** \brief 'GetPipeIdByName Err:Name not found,Name \%s,IdOut 0x%x,App \%s'
-** \event 'GetPipeIdByName Err:Name not found,Name \%s,IdOut 0x%x,App \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the #CFE_SB_GetPipeIdByName API receives an
-** invalid name.
-**/
-#define CFE_SB_GETPIPEIDBYNAME_NAME_ERR_EID 67
-
-/** \brief 'Subscribe Err:Bad Arg,MsgId 0x\%x,PipeId \%d,app \%s,scope \%d'
-** \event 'Subscribe Err:Bad Arg,MsgId 0x\%x,PipeId \%d,app \%s,scope \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when one of the Subscribe API's are called
-** with an invalid MsgId. An invalid MsgId is defined as being greater than the
-** cfg param #CFE_PLATFORM_SB_HIGHEST_VALID_MSGID.
-**
-**/
+/**
+ * \brief SB Subscribe API Bad Argument Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Subscribe API failed due to an invalid input argument.
+ */
#define CFE_SB_SUB_ARG_ERR_EID 6
-/** \brief 'Duplicate Subscription,MsgId 0x\%x on \%s pipe,app \%s'
-** \event 'Duplicate Subscription,MsgId 0x\%x on \%s pipe,app \%s'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This info event message is issued when a subscription request is received that
-** already exists in the routing table. A duplicate subscription is defined by a
-** matching MsgId and PipeId. No other parameters are used in detecting a duplicate
-** subscription.
-** NOTE: By default, SB filters this event. The EVS filter algorithm allows the
-** first event to pass through the filter, but all subsequent events with this
-** event id will be filtered. A command must be sent to unfilter this event if
-** the user desires to see it.
-**/
+/**
+ * \brief SB Subscribe API Duplicate MsgId Subscription Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * An SB Subscribe API was called with a Message ID that was already subscribed on the pipe
+ * on the pipe.
+ */
#define CFE_SB_DUP_SUBSCRIP_EID 7
-/** \brief 'Subscribe Err:Max Msgs(\%d)In Use,MsgId 0x\%x,pipe \%s,app \%s'
-** \event 'Subscribe Err:Max Msgs(\%d)In Use,MsgId 0x\%x,pipe \%s,app \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when one of the SB subscribe APIs are called
-** with a new MsgId, and SB cannot accommodate the new MsgId because the maximum
-** number of MsgIds are in use. The maximum number of MsgIds is defined by cfg param
-** #CFE_PLATFORM_SB_MAX_MSG_IDS. This cfg param dictates the number of elements in the SB
-** routing table. There is one element per MsgId. The user may monitor the routing
-** table utilization figures (msgids currently in use, high water mark and max
-** allowed) by sending the SB cmd to dump the SB statistics data.
-**/
+/**
+ * \brief SB Subscribe API Max Subscriptions Exceeded Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Subscribe API was called on a pipe that already has the maximum allowed
+ * number of subscriptions.
+ */
#define CFE_SB_MAX_MSGS_MET_EID 8
-/** \brief 'Subscribe Err:Max Dests(\%d)In Use For Msg 0x\%x,pipe \%s,app \%s'
-** \event 'Subscribe Err:Max Dests(\%d)In Use For Msg 0x\%x,pipe \%s,app \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when a subscription request is received and
-** all destinations for that MsgId are in use. The number of destinations per msgid
-** is a configuration parameter named #CFE_PLATFORM_SB_MAX_DEST_PER_PKT. A destination is
-** defined as a pipe.
-**/
+/**
+ * \brief SB Subscribe API Max Destinations Exceeded Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Subscribe API was called with a message id that already has the
+ * maximum allowed number of destinations.
+ */
#define CFE_SB_MAX_DESTS_MET_EID 9
-/** \brief 'Subscription Rcvd:MsgId 0x\%x on \%s(\%d),app \%s'
-** \event 'Subscription Rcvd:MsgId 0x\%x on \%s(\%d),app \%s'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This debug event message is issued when a subscription is successfully made
-** through one of the SB Subscribe API's
-**/
+/**
+ * \brief SB Subscribe API Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * An SB Subscribe API completed successfully.
+ */
#define CFE_SB_SUBSCRIPTION_RCVD_EID 10
-/** \brief 'UnSubscribe Err:Bad Arg,MsgId 0x\%x,PipeId \%d,app \%s,scope \%d'
-** \event 'UnSubscribe Err:Bad Arg,MsgId 0x\%x,PipeId \%d,app \%s,scope \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when a request to unsubscribe fails due to
-** an invalid msgid or an invalid pipeid in one of SB's unsubscribe API's. The msgid
-** must be less than cfg param #CFE_PLATFORM_SB_HIGHEST_VALID_MSGID and the pipeid must have
-** been created and have a value less than cfg param #CFE_PLATFORM_SB_MAX_PIPES. The SB pipe
-** table may be viewed to verify its value or existence.
-**/
+/**
+ * \brief SB Unsubscribe API Bad Argument Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Unsubscribe API failed due to an invalid input argument.
+ */
#define CFE_SB_UNSUB_ARG_ERR_EID 11
-/** \brief 'Unsubscribe Err:No subs for Msg 0x\%x on \%s,app \%s'
-** \event 'Unsubscribe Err:No subs for Msg 0x\%x on \%s,app \%s'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This info event message is issued when a request to unsubscribe fails due to
-** a non existent msgid/pipeid combination in the SB routing table. The SB routing
-** table may be viewed to see a list of valid msgid/pipeid combinations.
-**/
+/**
+ * \brief SB Unsubscribe API No MsgId Subscription Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * An SB Unsubscribe API was called with a Message ID that wasn't subscribed on the pipe
+ */
#define CFE_SB_UNSUB_NO_SUBS_EID 12
-/** \brief 'Send Err:Bad input argument,Arg 0x\%x,App \%s'
-** \event 'Send Err:Bad input argument,Arg 0x\%x,App \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when a transmit API receives an
-** invalid (possibly NULL) ptr as an argument.
-**/
+/**
+ * \brief SB Transmit API Bad Argument Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Transmit API failed due to an invalid imput argument.
+ */
#define CFE_SB_SEND_BAD_ARG_EID 13
-/** \brief 'No subscribers for MsgId 0x\%x,sender \%s'
-** \event 'No subscribers for MsgId 0x\%x,sender \%s'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This info event message is issued when a transmit API is called and there
-** are no subscribers (therefore no destinations) for the message to be sent. Each
-** time the SB detects this situation, the corresponding SB telemetry point is
-** incremented..
-** NOTE: By default, SB filters this event. The EVS filter algorithm allows the
-** first event to pass through the filter, but all subsequent events with this
-** event id will be filtered. A command must be sent to unfilter this event if
-** the user desires to see it.
-**/
+/**
+ * \brief SB Transmit API No MsgId Subscribers Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * An SB Transmit API was called with a Message ID with no subscriptions.
+ */
#define CFE_SB_SEND_NO_SUBS_EID 14
-/** \brief 'Send Err:Msg Too Big MsgId=0x\%x,app=\%s,size=\%d,MaxSz=\%d'
-** \event 'Send Err:Msg Too Big MsgId=0x\%x,app=\%s,size=\%d,MaxSz=\%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when a transmit API is called and the
-** packet length field in the message header implies that the message size exceeds
-** the max size defined by mission cfg param #CFE_MISSION_SB_MAX_SB_MSG_SIZE. The request to
-** send the message is denied, there is no partial packet sent.
-**/
+/**
+ * \brief SB Transmit API Message Size Limit Exceeded Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Transmit API was called with a message that is too big.
+ */
#define CFE_SB_MSG_TOO_BIG_EID 15
-/** \brief 'Send Err:Request for Buffer Failed. MsgId 0x\%x,app \%s,size \%d'
-** \event 'Send Err:Request for Buffer Failed. MsgId 0x\%x,app \%s,size \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when a transmit API fails to receive
-** the necessary buffer memory from the ES memory pool. This could be an indication
-** that the cfg param #CFE_PLATFORM_SB_BUF_MEMORY_BYTES is set too low. To check this, send SB
-** cmd to dump the SB statistics pkt and view the buffer memory parameters.
-**/
+/**
+ * \brief SB Transmit API Buffer Request Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Transmit API call buffer request failed.
+ */
#define CFE_SB_GET_BUF_ERR_EID 16
-/** \brief 'Send Err:Msg Limit Err MsgId 0x\%x,pipe \%s,sender \%s'
-** \event 'Send Err:Msg Limit Err MsgId 0x\%x,pipe \%s,sender \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when a transmit API cannot route the
-** MsgId (displayed in event) to the pipe (displayed in the event) because the pipe
-** currently contains the maximum number of messages of this type (MsgId). This is
-** typically an indication that the receiver is not reading its pipe fast enough, or
-** at all. A less typical scenerio is that the sender is sending a burst of pkts of
-** this type (or MsgId) and the receiver (owner of 'pipe') cannot keep up. The
-** subscriber of the message dictates this limit count in the 'MsgLim' parameter of
-** the #CFE_SB_SubscribeEx API or uses the default value of 4 if using the
-** #CFE_SB_Subscribe API.
-**/
+/**
+ * \brief SB Transmit API MsgId Pipe Limit Exceeded Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Transmit API call failed to deliver the MsgId to a pipe due to the
+ * limit for the number of messages with that MsgId for that pipe being exceeded.
+ */
#define CFE_SB_MSGID_LIM_ERR_EID 17
-/** \brief 'Rcv Err:Bad Input Arg:BufPtr 0x\%x,pipe \%d,t/o \%d,app \%s'
-** \event 'Rcv Err:Bad Input Arg:BufPtr 0x\%x,pipe \%d,t/o \%d,app \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when an invalid paramter is passed into the
-** #CFE_SB_ReceiveBuffer API. Two possibile problems would be the first parameter (*BufPtr)
-** being NULL or the third paramter (TimeOut) being less than -1.
-**/
+/**
+ * \brief SB Receive Buffer API Bad Argument Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_ReceiveBuffer API failure due to a bad input argument.
+ */
#define CFE_SB_RCV_BAD_ARG_EID 18
-/** \brief 'Rcv Err:PipeId \%d does not exist,app \%s'
-** \event 'Rcv Err:PipeId \%d does not exist,app \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when an invalid PipeId is passed into the
-** #CFE_SB_ReceiveBuffer API. The SB Pipe Table shows all valid PipeIds and may be viewed
-** for verification.
-**/
+/**
+ * \brief SB Receive Buffer API Invalid Pipe Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_ReceiveBuffer API falure due to an invalid Pipe ID.
+ */
#define CFE_SB_BAD_PIPEID_EID 19
-/** \brief 'Subscribe Err:Request for Destination Blk failed for Msg 0x\%x,Pipe \%s'
-** \event 'Subscribe Err:Request for Destination Blk failed for Msg 0x\%x,Pipe \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the SB receives an error from the memory
-** pool in the attempt to obtain a new destination block. Then memory pool statistics
-** may be viewed by sending the related ES command.
-**/
+/**
+ * \brief SB Subscribe API Get Destination Block Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Subscribe API call failed to get a destination block.
+ */
#define CFE_SB_DEST_BLK_ERR_EID 20
-/** \brief 'Send Err:Invalid msgid in msg,MsgId 0x\%x,App \%s'
-** \event 'Send Err:Invalid msgid in msg,MsgId 0x\%x,App \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when a transmit API is called and
-** the SB discovers that the message to send has a msg id that is invalid. It may be
-** due to a msg id that is greater than cfg parameter #CFE_PLATFORM_SB_HIGHEST_VALID_MSGID
-**/
+/**
+ * \brief SB Transmit API Invalid MsgId Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Transmit API was called with an invalid message ID.
+ */
#define CFE_SB_SEND_INV_MSGID_EID 21
-/** \brief 'Sending Subscription Report Msg=0x\%x,Pipe=\%d,Stat=0x\%x'
-** \event 'Sending Subscription Report Msg=0x\%x,Pipe=\%d,Stat=0x\%x'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This debug event message is issued when SB subscription reporting is enabled,
-** (which is disabled by default) and a subscription is successfully received.
-**/
+/**
+ * \brief SB Subscription Report Sent Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * SB Subscription Report sent in response to a successful subscription.
+ */
#define CFE_SB_SUBSCRIPTION_RPT_EID 22
-/** \brief 'Msg hash collision: MsgId = 0x\%x, collisions = \%u'
-** \event 'Msg hash collision: MsgId = 0x\%x, collisions = \%u'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated when a message id hash collision occurs when subscribing
-** to a message. Collisions indicate how many slots were incremented to find an opening.
-**
-** Number of collisions will directly impact software bus performance. These can be resolved
-** by adjusting MsgId values or increasing CFE_PLATFORM_SB_MAX_MSG_IDS.
-**/
+/**
+ * \brief SB Subscribe API Message Table Hash Collision Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * An SB Subscribe API call caused a message table hash collision, which will impact
+ * message transmission performance. This can be resolved by deconflicting MsgId values
+ * or increasing #CFE_PLATFORM_SB_MAX_MSG_IDS.
+ */
#define CFE_SB_HASHCOLLISION_EID 23
-/** \brief 'Pipe Overflow,MsgId 0x\%x,pipe \%s,stat 0x\%x,app \%s'
-** \event 'Pipe Overflow,MsgId 0x\%x,pipe \%s,stat 0x\%x,app \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when a transmit API is called and
-** encounters an error when attempting to write the msg to the destination pipe
-** (which is an underlying queue). This could indicate that the owner of the pipe is
-** not readings its messages fast enough or at all. It may also mean that the
-** pipe depth is not deep enough. The pipe depth is an input parameter to the
-** #CFE_SB_CreatePipe API.
-**/
+/**
+ * \brief SB Transmit API Pipe Overflow Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Transmit API call failed to deliver the Message ID to a pipe due to the
+ * pipe queue being full.
+ */
#define CFE_SB_Q_FULL_ERR_EID 25
-/** \brief 'Pipe Write Err,MsgId 0x\%x,pipe \%s,stat 0x\%x,app \%s'
-** \event 'Pipe Write Err,MsgId 0x\%x,pipe \%s,stat 0x\%x,app \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when a transmit API is called and
-** encounters an error when attempting to write the msg to the destination pipe
-** (which is an underlying queue). More precisely, the OS API #OS_QueuePut has
-** returned an unexpected error. The return code is displayed in the event. For
-** more information, the user may look up the return code in the OSAL documention or
-** source code.
-**/
+/**
+ * \brief SB Transmit API Queue Write Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Transmit API call failed due to a pipe queue write failure.
+ */
#define CFE_SB_Q_WR_ERR_EID 26
-/** \brief 'Pipe Read Err,pipe \%s,app \%s,stat 0x\%x'
-** \event 'Pipe Read Err,pipe \%s,app \%s,stat 0x\%x'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when a transmit API is called and
-** encounters an error when attempting to read the msg from the destination pipe
-** (which is an underlying queue). More precisely, the OS API #OS_QueueGet has
-** returned an unexpected error. The return code is displayed in the event. For
-** more information, the user may look up the return code in the OSAL documention or
-** source code.
-**/
+/**
+ * \brief SB Transmit API Queue Read Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Transmit API called failed due to a pipe queue read failure.
+ */
#define CFE_SB_Q_RD_ERR_EID 27
-/** \brief 'No-op Cmd Rcvd'
-** \event 'No-op Cmd Rcvd'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This info event message is issued in response an SB NO-OP command
-**/
+/**
+ * \brief SB No-op Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_SB_NOOP_CC SB NO-OP Command \endlink success.
+ */
#define CFE_SB_CMD0_RCVD_EID 28
-/** \brief 'Reset Counters Cmd Rcvd'
-** \event 'Reset Counters Cmd Rcvd'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This debug event message is issued in response an SB Reset Counters command
-**/
+/**
+ * \brief SB Reset Counters Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_SB_RESET_COUNTERS_CC SB Reset Counters Command \endlink success.
+ */
#define CFE_SB_CMD1_RCVD_EID 29
-/** \brief 'Software Bus Statistics packet sent'
-** \event 'Software Bus Statistics packet sent'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This debug event message is issued when SB receives a cmd to send the SB
-** statistics pkt.
-**/
+/**
+ * \brief SB Send Statistics Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_SB_SEND_SB_STATS_CC SB Send Statistics Command \endlink success.
+ */
#define CFE_SB_SND_STATS_EID 32
-/** \brief 'Enbl Route Cmd:Route does not exist.Msg 0x\%x,Pipe \%d'
-** \event 'Enbl Route Cmd:Route does not exist.Msg 0x\%x,Pipe \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when SB receives a cmd to enable a route that
-** does not exist in the routing table. A route is defined by a MsgId, PipeId pair.
-**/
+/**
+ * \brief SB Enable Route Command Invalid MsgId/PipeID Pair Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_SB_ENABLE_ROUTE_CC SB Enable Route Command \endlink failure due
+ * to the Message ID not being subscribed to the pipe.
+ */
#define CFE_SB_ENBL_RTE1_EID 33
-/** \brief 'Enabling Route,Msg 0x\%x,Pipe \%d'
-** \event 'Enabling Route,Msg 0x\%x,Pipe \%d'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This debug event message is issued when SB receives a cmd to enable a route and
-** the request is successfully executed.
-**/
+/**
+ * \brief SB Enable Route Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_SB_ENABLE_ROUTE_CC SB Enable Route Command \endlink success.
+ */
#define CFE_SB_ENBL_RTE2_EID 34
-/** \brief 'Enbl Route Cmd:Invalid Param.Msg 0x\%x,Pipe \%d'
-** \event 'Enbl Route Cmd:Invalid Param.Msg 0x\%x,Pipe \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when SB receives a cmd to enable a route and
-** the MsgId or PipeId does not pass the validation checks. The MsgId must be less
-** than cfg param #CFE_PLATFORM_SB_HIGHEST_VALID_MSGID. The PipeId must exist and be less than
-** cfg param #CFE_PLATFORM_SB_MAX_PIPES. The SB pipe table may be viewed to verify the PipeId
-** existence.
-**/
+/**
+ * \brief SB Enable Route Command Invalid MsgId or Pipe Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_SB_ENABLE_ROUTE_CC SB Enable Route Command \endlink failure due
+ * to an invalid MsgId or Pipe.
+ */
#define CFE_SB_ENBL_RTE3_EID 35
-/** \brief 'Disable Route Cmd:Route does not exist,Msg 0x\%x,Pipe \%d'
-** \event 'Disable Route Cmd:Route does not exist,Msg 0x\%x,Pipe \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when SB receives a cmd to disable a route that
-** does not exist in the routing table. A route is defined by a MsgId, PipeId pair.
-**/
+/**
+ * \brief SB Disable Route Command Invalid MsgId/PipeId Pair Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_SB_DISABLE_ROUTE_CC SB Disable Route Command \endlink failure due
+ * to the Message ID not being subscribed to the pipe.
+ */
#define CFE_SB_DSBL_RTE1_EID 36
-/** \brief 'Route Disabled,Msg 0x\%x,Pipe \%d'
-** \event 'Route Disabled,Msg 0x\%x,Pipe \%d'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This debug event message is issued when SB receives a cmd to disable a route and
-** the request is successfully executed.
-**/
+/**
+ * \brief SB Disable Route Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_SB_DISABLE_ROUTE_CC SB Disable Route Command \endlink success.
+ */
#define CFE_SB_DSBL_RTE2_EID 37
-/** \brief 'Disable Route Cmd:Invalid Param.Msg 0x\%x,Pipe \%d'
-** \event 'Disable Route Cmd:Invalid Param.Msg 0x\%x,Pipe \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when SB receives a cmd to disable a route and
-** the MsgId or PipeId does not pass the validation checks. The MsgId must be less
-** than cfg param #CFE_PLATFORM_SB_HIGHEST_VALID_MSGID. The PipeId must exist and be less than
-** cfg param #CFE_PLATFORM_SB_MAX_PIPES. The SB pipe table may be viewed to verify the PipeId
-** existence.
-**/
+/**
+ * \brief SB Disable Route Command Invalid MsgId or Pipe Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_SB_DISABLE_ROUTE_CC SB Disable Route Command \endlink failure due
+ * to an invalid MsgId or Pipe.
+ */
#define CFE_SB_DSBL_RTE3_EID 38
-/** \brief '\%s written:Size=\%d,Entries=\%d'
-** \event '\%s written:Size=\%d,Entries=\%d'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This debug event message is issued after the SB routing info file, pipe info
-** file or the map info file is written and closed. This is done is response to
-** the SB 'Send Routing Info' cmd, the SB 'Send pipe Info' cmd or the SB 'Send
-** Map Info' cmd, respectively.
-**/
+/**
+ * \brief SB File Write Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * An SB file write successfully completed. OVERLOADED
+ */
#define CFE_SB_SND_RTG_EID 39
-/** \brief 'Error creating file \%s, stat=0x\%x'
-** \event 'Error creating file \%s, stat=0x\%x'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the SB 'Send Routing Info' cmd is
-** received and the file create fails. The event displays the status received from
-** the OS.
-**/
+/**
+ * \brief SB File Write Create File Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB file write failure due to file creation error. OVERLOADED
+ */
#define CFE_SB_SND_RTG_ERR1_EID 40
-/** \brief 'Invalid Cmd, Unexpected Command Code \%d'
-** \event 'Invalid Cmd, Unexpected Command Code \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the SB receives a cmd that has an
-** unexpected cmd code.
-**/
+/**
+ * \brief SB Invalid Command Code Received Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid command code for message ID #CFE_SB_CMD_MID or #CFE_SB_SUB_RPT_CTRL_MID received
+ * on the SB message pipe. OVERLOADED
+ */
#define CFE_SB_BAD_CMD_CODE_EID 42
-/** \brief 'Invalid Cmd, Unexpected Msg Id: 0x\%x'
-** \event 'Invalid Cmd, Unexpected Msg Id: 0x\%x'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the SB receives a msg that has an
-** unexpected msg id.
-**/
+/**
+ * \brief SB Invalid Message ID Received Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid message ID received on the SB message pipe.
+ */
#define CFE_SB_BAD_MSGID_EID 43
-/** \brief 'Full Sub Pkt \%d Sent,Entries=\%d,Stat=0x\%x\n'
-** \event 'Full Sub Pkt \%d Sent,Entries=\%d,Stat=0x\%x\n'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This debug event message is issued in response to the
-** 'Send Previous Subscriptions' command and a full pkt segment is sent.
-**/
+/**
+ * \brief SB Send Previous Subscriptions Command Full Packet Sent Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_SB_SEND_PREV_SUBS_CC SB Send Previous Subscriptions Command \endlink processing
+ * sent a full subscription packet.
+ */
#define CFE_SB_FULL_SUB_PKT_EID 44
-/** \brief 'Partial Sub Pkt \%d Sent,Entries=\%d,Stat=0x\%x'
-** \event 'Partial Sub Pkt \%d Sent,Entries=\%d,Stat=0x\%x'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This debug event message is issued in response to the
-** 'Send Previous Subscriptions' command and a partial pkt segment is sent.
-**/
+/**
+ * \brief SB Send Previous Subscriptions Command Partial Packet Sent Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_SB_SEND_PREV_SUBS_CC SB Send Previous Subscriptions Command \endlink processing
+ * sent a partial subscription packet.
+ */
#define CFE_SB_PART_SUB_PKT_EID 45
-/** \brief 'Pipe Delete Error:Bad Argument,PipedId \%d,Requestor \%s,Idx \%d,Stat \%d'
-** \event 'Pipe Delete Error:Bad Argument,PipedId \%d,Requestor \%s,Idx \%d,Stat \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued from CFE_SB_DeletePipeFull when an
-** invalid pipe ID is passed in
-**/
+/**
+ * \brief SB Pipe Delete API Bad Argument Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Delete Pipe API failed due to an invalid input argument.
+ */
#define CFE_SB_DEL_PIPE_ERR1_EID 46
-/** \brief 'Pipe Deleted:id \%d,owner \%s'
-** \event 'Pipe Deleted:id \%d,owner \%s'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This debug event message is issued when the #CFE_SB_DeletePipe API is called and
-** the request is successfully completed.
-**/
+/**
+ * \brief SB Pipe Delete API Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * An SB Delete Pipe API successfully completed.
+ */
#define CFE_SB_PIPE_DELETED_EID 47
-/** \brief 'Subscription Removed:Msg 0x\%x on pipe \%d,app \%s'
-** \event 'Subscription Removed:Msg 0x\%x on pipe \%d,app \%s'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This debug event message is issued when #CFE_SB_Unsubscribe API is called
-** and the request is successfully completed.
-**/
+/**
+ * \brief SB Unsubscribe API Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * An SB Unsubscribe API successfully completed.
+ */
#define CFE_SB_SUBSCRIPTION_REMOVED_EID 48
-/** \brief 'File write,byte cnt err,file \%s,request=\%d,actual=\%d'
-** \event 'File write,byte cnt err,file \%s,request=\%d,actual=\%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when one of many SB's file write operations
-** is unsuccessful. This event is a result of #CFE_FS_WriteHeader or OS_write
-** returning something other than the number of bytes requested to be written.
-** The requested value and the return value are displayed in the event.
-**/
+/**
+ * \brief SB File Write Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB file write failure encountered when writing to the file.
+ */
#define CFE_SB_FILEWRITE_ERR_EID 49
-/** \brief 'Subscribe Err:Invalid Pipe Id,Msg=0x\%x,PipeId=\%d,App \%s'
-** \event 'Subscribe Err:Invalid Pipe Id,Msg=0x\%x,PipeId=\%d,App \%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the input PipeId has a value that is not
-** listed in the pipe table. This typically means that the pipe does not exist.
-** The pipe table may be viewed for verification.
-**/
+/**
+ * \brief SB Subscribe API Invalid Pipe Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Subscribe API failed due to an invalid pipe ID.
+ */
#define CFE_SB_SUB_INV_PIPE_EID 50
-/** \brief 'Subscribe Err:Caller(\%s) is not the owner of pipe \%d, Msg=0x\%x'
-** \event 'Subscribe Err:Caller(\%s) is not the owner of pipe \%d, Msg=0x\%x'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when one of the SB subscribe API's are called
-** and the requestor is not the owner of the pipe. Only the owner of the pipe may
-** subscribe to messages on the pipe.
-**/
+/**
+ * \brief SB Subscribe API Not Owner Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Subscribe API failed due to not being the pipe owner.
+ */
#define CFE_SB_SUB_INV_CALLER_EID 51
-/** \brief 'Unsubscribe Err:Invalid Pipe Id Msg=0x\%x,Pipe=\%d,app=\%s'
-** \event 'Unsubscribe Err:Invalid Pipe Id Msg=0x\%x,Pipe=\%d,app=\%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when one of the SB unsubscribe API's are
-** called and the input parameter PipeId is not listed in the pipe table.
-** This typically means that the pipe does not exist. The pipe table may be viewed
-** for verification.
-**/
+/**
+ * \brief SB Unsubscribe API Invalid Pipe Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Unsubscribe API failed due to an invalid pipe ID.
+ */
#define CFE_SB_UNSUB_INV_PIPE_EID 52
-/** \brief 'Unsubscribe Err:Caller(\%s) is not the owner of pipe \%d,Msg=0x\%x'
-** \event 'Unsubscribe Err:Caller(\%s) is not the owner of pipe \%d,Msg=0x\%x'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when one of the SB unsubscribe API's are
-** called and the requestor is not the owner of the pipe (or ES). Only the owner of
-** the pipe(or ES for cleanup purposes)may unsubscribe messages from a pipe.
-**/
+/**
+ * \brief SB Unsubscribe API Not Owner Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Unsubscribe API failed due to not being the pipe owner.
+ */
#define CFE_SB_UNSUB_INV_CALLER_EID 53
-/** \brief 'Pipe Delete Error:Caller(\%s) is not the owner of pipe \%d'
-** \event 'Pipe Delete Error:Caller(\%s) is not the owner of pipe \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the #CFE_SB_DeletePipe API is called by a
-** task that is not the owner of the pipe. Pipes may be deleted only by the task
-** that created the pipe or ES(for cleanup purposes).
-**/
+/**
+ * \brief SB Delete Pipe API Not Owner Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * An SB Delete Pipe API failed due to not being the pipe owner.
+ */
#define CFE_SB_DEL_PIPE_ERR2_EID 54
-/** \brief 'Invalid cmd length: ID = 0x\%X, CC = \%d, Exp Len = \%d, Len = \%d'
-** \event 'Invalid cmd length: ID = 0x\%X, CC = \%d, Exp Len = \%d, Len = \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a message with the #CFE_SB_CMD_MID
-** message ID has arrived but whose packet length does not match the expected
-** length for the specified command code.
-**
-** The \c ID field in the event message specifies the Message ID (in hex), the \c CC field
-** specifies the Command Code (in decimal), the \c Exp Len field specified the Expected
-** Length (in decimal ), and \c Len specifies the message Length (in decimal)
-** found in the message.
-**/
-#define CFE_SB_LEN_ERR_EID 61
-
-/** \brief 'CreatePipeErr:Name Taken:app=\%s,ptr=0x\%x,depth=\%d,maxdepth=\%d'
-** \event 'CreatePipeErr:Name Taken:app=\%s,ptr=0x\%x,depth=\%d,maxdepth=\%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the #CFE_SB_CreatePipe API tries to create
-** a pipe with a name that is in use.
-**/
-#define CFE_SB_CR_PIPE_NAME_TAKEN_EID 62
+/**
+ * \brief SB Set Pipe Opts API Invalid Pipe Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_SetPipeOpts API failure due to an invalid pipe ID
+ */
+#define CFE_SB_SETPIPEOPTS_ID_ERR_EID 55
-/** \brief 'CreatePipeErr:No Free:app=\%s,ptr=0x\%x,depth=\%d,maxdepth=\%d'
-** \event 'CreatePipeErr:No Free:app=\%s,ptr=0x\%x,depth=\%d,maxdepth=\%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This error event message is issued when the #CFE_SB_CreatePipe API is unable to
-** create a queue because there are no queues free.
-**/
-#define CFE_SB_CR_PIPE_NO_FREE_EID 63
+/**
+ * \brief SB Set Pipe Opts API Not Owner Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_SetPipeOpts API failure due to not being the pipe owner.
+ */
+#define CFE_SB_SETPIPEOPTS_OWNER_ERR_EID 56
+
+/**
+ * \brief SB Set Pipe Opts API Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_SetPipeOpts success.
+ */
+#define CFE_SB_SETPIPEOPTS_EID 57
+
+/**
+ * \brief SB Get Pipe Opts API Invalid Pipe Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_GetPipeOpts failure due to invalid pipe ID.
+ */
+#define CFE_SB_GETPIPEOPTS_ID_ERR_EID 58
+
+/**
+ * \brief SB Get Pipe Opts API Invalid Pointer Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_GetPipeOpts failure due to invalid pointer.
+ */
+#define CFE_SB_GETPIPEOPTS_PTR_ERR_EID 59
+
+/**
+ * \brief SB Get Pipe Opts API Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_GetPipeOpts success.
+ */
+#define CFE_SB_GETPIPEOPTS_EID 60
+
+/**
+ * \brief SB Get Pipe Name API Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_GetPipeName success.
+ */
+#define CFE_SB_GETPIPENAME_EID 62
+
+/**
+ * \brief SB Get Pipe Name API Invalid Pointer Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_GetPipeName failure due to invalid pointer.
+ */
+#define CFE_SB_GETPIPENAME_NULL_PTR_EID 63
+
+/**
+ * \brief SB Get Pipe Name API Invalid Pipe or Resource Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_GetPipeName failure due to invalid pipe ID or failure in retreiving resource name. OVERLOADED
+ */
+#define CFE_SB_GETPIPENAME_ID_ERR_EID 64
+
+/**
+ * \brief SB Get Pipe ID By Name API Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_GetPipeIdByName success.
+ */
+#define CFE_SB_GETPIPEIDBYNAME_EID 65
+
+/**
+ * \brief SB Get Pipe ID By Name API Invalid Pointer Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_GetPipeIdByName failure due to invalid pointer.
+ */
+#define CFE_SB_GETPIPEIDBYNAME_NULL_ERR_EID 66
+
+/**
+ * \brief SB Get Pipe ID By Name API Name Not Found Or ID Not Matched Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_GetPipeIdByName faiure due to name not found or ID mismatch. OVERLOADED
+ */
+#define CFE_SB_GETPIPEIDBYNAME_NAME_ERR_EID 67
+
+/**
+ * \brief SB Invalid Command Length Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid length for the command code in message ID #CFE_SB_CMD_MID or #CFE_SB_SUB_RPT_CTRL_MID
+ * received on the SB message pipe.
+ */
+#define CFE_SB_LEN_ERR_EID 68
+
+/**
+ * \brief SB Create Pipe API Name Taken Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_CreatePipe API failure due to pipe name taken.
+ */
+#define CFE_SB_CR_PIPE_NAME_TAKEN_EID 69
+
+/**
+ * \brief SB Create Pipe API Queues Exhausted Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_SB_CreatePipe API failure due to no free queues.
+ */
+#define CFE_SB_CR_PIPE_NO_FREE_EID 70
+/**\}*/
#endif /* CFE_SB_EVENTS_H */
diff --git a/modules/tbl/fsw/inc/cfe_tbl_events.h b/modules/tbl/fsw/inc/cfe_tbl_events.h
index ad100681c..380673c16 100644
--- a/modules/tbl/fsw/inc/cfe_tbl_events.h
+++ b/modules/tbl/fsw/inc/cfe_tbl_events.h
@@ -21,1080 +21,814 @@
/**
* @file
*
- * Title: Table Services API Event ID Header File
- *
- * Purpose:
- * Identifies event codes for event messages issued by Table Services.
- *
- * Design Notes:
- *
- * References:
- * Flight Software Branch C Coding Standard Version 1.0a
- *
- * Notes:
- *
+ * cFE Table Services Event IDs
*/
#ifndef CFE_TBL_EVENTS_H
#define CFE_TBL_EVENTS_H
-/* **************************
-** ****** Maximum EID. ******
-** **************************
-** The EID's below may not necessarily be in order, so it can be difficult to
-** determine what the next EID is to use. When you add EID's, start with MAX_EID + 1
-** and when you're done adding, set this to the highest EID you used. It may
-** be worthwhile to, on occasion, re-number the EID's to put them back in order.
-*/
-#define CFE_TBL_MAX_EID 103
-
-/******************* Macro Definitions ***********************/
-/*
-** Event message ID's
-*/
+/**
+ * \name TBL event IDs
+ */
+/**\{*/
-/** \name Informational Event Message IDs */
-/** \{ */
-/** \brief 'Task Initialized'
-** \event 'Task Initialized'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always automatically issued when the Table Services
-** Task completes its Initialization.
-**/
+/**
+ * \brief TB Initialization Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * Table Services Taks initialization complete.
+ */
#define CFE_TBL_INIT_INF_EID 1
-/** \} */
-
-/** \name Command Response Informational Event Message IDs */
-/** \{ */
-/** \brief 'No-op command'
-** \event 'No-op command'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always automatically issued in response
-** to a cFE Table Services \link #CFE_TBL_NOOP_CC NO-OP command \endlink
-**/
+/**
+ * \brief TBL No-op Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_NOOP_CC NO-OP TBL No-op Command \endlink success.
+ */
#define CFE_TBL_NOOP_INF_EID 10
-/** \brief 'Reset Counters command'
-** \event 'Reset Counters command'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always automatically issued in response
-** to a cFE Table Services \link #CFE_TBL_RESET_COUNTERS_CC Reset Counters command \endlink
-**/
+/**
+ * \brief TBL Reset Counters Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_RESET_COUNTERS_CC TBL Reset Counters Command \endlink success.
+ */
#define CFE_TBL_RESET_INF_EID 11
-/** \brief 'Successful load of '\%s' into '\%s' working buffer'
-** \event 'Successful load of '\%s' into '\%s' working buffer'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always generated after a successful execution of
-** a cFE Table Services \link #CFE_TBL_LOAD_CC Load Table command \endlink
-**/
+/**
+ * \brief TBL Load Table Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_LOAD_CC TBL Load Table Command \endlink successfully loaded
+ * the new table data to the working buffer.
+ */
#define CFE_TBL_FILE_LOADED_INF_EID 12
-/** \brief 'Successfully overwrote '\%s' with Table '\%s''
-** \event 'Successfully overwrote '\%s' with Table '\%s''
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always generated after a successful execution of
-** a cFE Table Services \link #CFE_TBL_DUMP_CC Dump Table command \endlink where
-** the command specified target filename was the same as a file already present
-** in the onboard filesystem. If the specified file did not exist, the event
-** message would have been #CFE_TBL_WRITE_DUMP_INF_EID.
-**/
+/**
+ * \brief TBL Write Table To Existing File Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * TBL write table to an existing file success.
+ */
#define CFE_TBL_OVERWRITE_DUMP_INF_EID 13
-/** \brief 'Successfully dumped Table '\%s' to '\%s''
-** \event 'Successfully dumped Table '\%s' to '\%s''
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always generated after a successful execution of
-** a cFE Table Services \link #CFE_TBL_DUMP_CC Dump Table command \endlink where
-** the command specified target filename was a currently non-existent file. If
-** the file did already exist, the event message would have been
-** #CFE_TBL_OVERWRITE_DUMP_INF_EID.
-**/
+/**
+ * \brief TBL Write Table To New File Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * TBL write table to a new file success.
+ */
#define CFE_TBL_WRITE_DUMP_INF_EID 14
-/** \brief 'Successfully overwrote '\%s' with Table Registry'
-** \event 'Successfully overwrote '\%s' with Table Registry'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is always generated after a successful execution of
-** a cFE Table Services \link #CFE_TBL_DUMP_REGISTRY_CC Dump Table Registry command \endlink where
-** the command specified target filename was the same as a file already present
-** in the onboard filesystem. If the specified file did not exist, the event
-** message would have been #CFE_TBL_WRITE_REG_DUMP_INF_EID.
-**/
+/**
+ * \brief TBL Write Table Registry To Existing File Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * TBL Write Table Registry to an existing file completed successfully.
+ */
#define CFE_TBL_OVERWRITE_REG_DUMP_INF_EID 15
-/** \brief 'Tbl Services issued validation request for '\%s''
-** \event 'Tbl Services issued validation request for '\%s''
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon successful execution of
-** a cFE Table Services \link #CFE_TBL_VALIDATE_CC Validate Table command \endlink.
-** It should be noted, however, that this Event Message does NOT indicate completion of
-** the Table Validation. It is ONLY indicating that the appropriate flag has been
-** set to NOTIFY the table's owning Application that a Validation has been requested.
-** Completion of the Validation is indicated by either the #CFE_TBL_VALIDATION_INF_EID or
-** #CFE_TBL_VALIDATION_ERR_EID event messages.
-**/
+/**
+ * \brief TBL Validate Table Request Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_VALIDATE_CC TBL Validate Table Command \endlink success.
+ * Note this event signifies the request to validate the table has been successfully
+ * submitted. Completion will generate a #CFE_TBL_VALIDATION_INF_EID or
+ * #CFE_TBL_VALIDATION_ERR_EID event messages.
+ */
#define CFE_TBL_VAL_REQ_MADE_INF_EID 16
-/** \brief 'Tbl Services notifying App that '\%s' has a load pending'
-** \event 'Tbl Services notifying App that '\%s' has a load pending'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon successful execution of
-** a cFE Table Services \link #CFE_TBL_ACTIVATE_CC Activate Table command \endlink.
-** It should be noted, however, that this Event Message does NOT indicate completion of
-** the Table Activation. It is ONLY indicating that the appropriate flag has been
-** set to NOTIFY the table's owning Application that an Update has been requested.
-** Completion of the Update is indicated by either the #CFE_TBL_UPDATE_SUCCESS_INF_EID or
-** #CFE_TBL_UPDATE_ERR_EID event messages.
-**/
+/**
+ * \brief TBL Load Table Pending Notification Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * TBL load table pending notification sucessfully sent.
+ */
#define CFE_TBL_LOAD_PEND_REQ_INF_EID 17
-/** \brief 'Table Registry entry for '\%s' will be telemetered'
-** \event 'Table Registry entry for '\%s' will be telemetered'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is generated upon successful execution of
-** a cFE Table Services \link #CFE_TBL_SEND_REGISTRY_CC Telemeter Table Registry Entry command \endlink.
-** Subsequent Table Services Housekeeping Telemetry should contain the desired Table Registry Entry data.
-**/
+/**
+ * \brief TBL Telemeter Table Registry Entry Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_SEND_REGISTRY_CC TBL Telemeter Table Registry Entry command \endlink successfully
+ * set the table registry index to telemeter in the next housekeeping packet.
+ */
#define CFE_TBL_TLM_REG_CMD_INF_EID 18
-/** \brief 'Table Load Aborted for '\%s''
-** \event 'Table Load Aborted for '\%s''
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated upon successful execution of
-** a cFE Table Services \link #CFE_TBL_ABORT_LOAD_CC Abort Table Load command \endlink.
-**/
+/**
+ * \brief TBL Abort Table Load Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_ABORT_LOAD_CC TBL Abort Table Load Command \endlink success.
+ */
#define CFE_TBL_LOAD_ABORT_INF_EID 21
-/** \brief 'Successfully dumped Table Registry to '\%s':Size=\%d,Entries=\%d'
-** \event 'Successfully dumped Table Registry to '\%s':Size=\%d,Entries=\%d'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is always generated after a successful execution of
-** a cFE Table Services \link #CFE_TBL_DUMP_REGISTRY_CC Dump Table Registry command \endlink where
-** the command specified target filename was a currently non-existent file. If
-** the file did already exist, the event message would have been
-** #CFE_TBL_OVERWRITE_REG_DUMP_INF_EID.
-**/
+/**
+ * \brief TBL Write Table Registry To New File Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * TBL Write Table Registry to a new file completed successfully.
+ */
#define CFE_TBL_WRITE_REG_DUMP_INF_EID 22
-/** \brief 'Tbl Services assumes '\%s' is valid. No Validation Function has been registered'
-** \event 'Tbl Services assumes '\%s' is valid. No Validation Function has been registered'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated when Table Services has received a Validation Command
-** for a table that never specified a Validation Function when it was registered via the
-** #CFE_TBL_Register API.
-**/
+/**
+ * \brief TBL Validate Table Valid Due To No Validation Function Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_VALIDATE_CC TBL Validate Table Command \endlink marking table
+ * as valid due to no validation functing being registered.
+ */
#define CFE_TBL_ASSUMED_VALID_INF_EID 23
-/** \} */
-/** \name Command Error Event Message IDs */
-/** \{ */
-/** \brief 'Invalid message ID -- ID = 0x\%X'
-** \event 'Invalid message ID -- ID = 0x\%X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a message has arrived on
-** the cFE Table Services Application's Message Pipe that has a
-** Message ID that is neither #CFE_TBL_SEND_HK_MID or #CFE_TBL_CMD_MID.
-** Most likely, the cFE Software Bus routing table has become corrupt
-** and is sending messages targeted for other Applications to the cFE
-** Table Services Application.
-**
-** The \c ID field in the event message identifies
-** the message ID (in hex) that was found in the message.
-**/
+/**
+ * \brief TBL Load Table API Success Event ID
+ *
+ * \par Type: DEBUG (the first time) and INFORMATION (normally)
+ *
+ * \par Cause:
+ *
+ * #CFE_TBL_Load API succes for dump only or normal table. OVERLOADED
+ */
+#define CFE_TBL_LOAD_SUCCESS_INF_EID 35
+
+/**
+ * \brief TBL Validate Table Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * Table active or inactive image successfully validated by the registerd validation function. OVERLOADED
+ */
+#define CFE_TBL_VALIDATION_INF_EID 36
+
+/**
+ * \brief TBL Update Table Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * Table update successfully completed.
+ */
+#define CFE_TBL_UPDATE_SUCCESS_INF_EID 37
+
+/**
+ * \brief TBL Delete Table CDS Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_DELETE_CDS_CC TBL Delete Table CDS Command \endlink success.
+ */
+#define CFE_TBL_CDS_DELETED_INFO_EID 38
+
+/**
+ * \brief TBL Invalid Message ID Received Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid message ID received on the TBL message pipe.
+ */
#define CFE_TBL_MID_ERR_EID 50
-/** \brief 'Invalid command code -- ID = 0x\%X, CC = \%d'
-** \event 'Invalid command code -- ID = 0x\%X, CC = \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a message with the #CFE_TBL_CMD_MID
-** message ID has arrived but whose Command Code is not one of the command
-** codes specified in \link #CFE_TBL_NOOP_CC cfe_tbl_msg.h \endlink. This
-** problem is most likely to occur when:
-** -# A Message ID meant for another Application became corrupted and was
-** set equal to #CFE_TBL_CMD_MID.
-** -# The Command Code field in the Message became corrupted.
-** -# The command database at the ground station has been corrupted.
-**
-** The \c ID field in the event message specifies the Message ID (in hex) and the
-** \c CC field specifies the Command Code (in decimal) found in the message.
-**/
+/**
+ * \brief TBL Invalid Command Code Received Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid command code for message ID #CFE_TBL_CMD_MID received on the TBL message pipe.
+ */
#define CFE_TBL_CC1_ERR_EID 51
-/** \brief 'Invalid cmd pkt -- ID = 0x\%X, CC = \%d, Len = \%d'
-** \event 'Invalid cmd pkt -- ID = 0x\%X, CC = \%d, Len = \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a message with the #CFE_TBL_CMD_MID
-** message ID has arrived but whose packet length does not match the expected
-** length for the specified command code.
-**
-** The \c ID field in the event message specifies the Message ID (in hex), the \c CC field
-** specifies the Command Code (in decimal) and \c Len specifies the message Length (in decimal)
-** found in the message.
-**/
+/**
+ * \brief TBL Invalid Command Length Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid length for the message ID and command code received on the TBL message pipe.
+ */
#define CFE_TBL_LEN_ERR_EID 52
-/** \brief 'Unable to open file '\%s' for table load, Status = 0x\%08X'
-** \event 'Unable to open file '\%s' for table load, Status = 0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated upon receipt of a
-** \link #CFE_TBL_LOAD_CC Load Table command \endlink when
-** the specified file containing the table image to be loaded
-** cannot be opened. Possible causes for this are:
-**
-** -# The filename was misspelled
-** -# The path to the file was incorrect
-** -# The length (including terminator) of the filename and/or path exceeds the
-** allowable length (see #OS_MAX_PATH_LEN and #OS_MAX_FILE_NAME, respectively)
-**
-** The \c Status field in the event message indicates the error code returned by the #OS_OpenCreate
-** API.
-**/
+/**
+ * \brief TBL Load Table File Open Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Load Table failure opening the file. OVERLOADED
+ */
#define CFE_TBL_FILE_ACCESS_ERR_EID 53
-/** \brief 'Unable to read std header for '\%s', Status = 0x\%08X'
-** \event 'Unable to read std header for '\%s', Status = 0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a read failure occurs during the reading of the
-** \link #CFE_FS_Header_t cFE Standard File Header \endlink of a table image file specified
-** either by an Application calling the #CFE_TBL_Load API or in response to a command to
-** Table Services requesting a table image file be loaded into an inactive buffer.
-**
-** The \c Status field of the event message contains the error code returned by #CFE_FS_ReadHeader.
-**/
+/**
+ * \brief TBL Load Table File Read Standard Header Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Load Table failure reading the file standard header.
+ */
#define CFE_TBL_FILE_STD_HDR_ERR_EID 54
-/** \brief 'Unable to read tbl header for '\%s', Status = 0x\%08X'
-** \event 'Unable to read tbl header for '\%s', Status = 0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a read failure occurs during the reading of the
-** \link #CFE_TBL_File_Hdr_t cFE Table File Secondary Header \endlink of a table image file specified
-** either by an Application calling the #CFE_TBL_Load API or in response to a command to
-** Table Services requesting a table image file be loaded into an inactive buffer.
-**
-** The \c Status field of the event message contains the error code returned by #OS_read.
-**/
+/**
+ * \brief TBL Load Table File Read Table Header Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Load Table failure reading the file table header.
+ */
#define CFE_TBL_FILE_TBL_HDR_ERR_EID 55
-/** \brief 'Unable to send Hk Packet (Status=0x\%08X)'
-** \event 'Unable to send Hk Packet (Status=0x\%08X)'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when failure occurs while attempting to send the
-** Housekeeping Message over the Software Bus.
-**
-** The \c Status field of the event message contains the error code.
-**/
+/**
+ * \brief TBL Send Housekeeping Command Transmit Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_SEND_HK_MID TBL Send Housekeeping Command \endlink failure
+ * transmitting the housekeeping message.
+ */
#define CFE_TBL_FAIL_HK_SEND_ERR_EID 56
-/** \brief 'Unable to locate '\%s' in Table Registry'
-** \event 'Unable to locate '\%s' in Table Registry'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a command that specifies a table name
-** has a table name that is not found in the Table Registry. Most likely causes
-** for this are:
-** -# Table name was misspelled in the command.
-** -# The Application that Registered the Table has either failed to run or
-** has been terminated thus removing the Table from the Registry.
-** -# The Table Registry has become corrupted.
-**/
+/**
+ * \brief TBL Table Name Not Found Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL commamnd handler unable to find table name. OVERLOADED
+ */
#define CFE_TBL_NO_SUCH_TABLE_ERR_EID 57
-/** \brief 'File '\%s' is not a cFE file type, ContentType = 0x\%08X'
-** \event 'File '\%s' is not a cFE file type, ContentType = 0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when either an Application calls the #CFE_TBL_Load API
-** or a Table Load command has been received and the specified file has a \link #CFE_FS_Header_t
-** cFE Standard File Header \endlink whose \link #CFE_FS_Header_t::ContentType Content Type \endlink
-** is not equal to the expected #CFE_FS_FILE_CONTENT_ID. Most likely causes for this are:
-** -# The specified file is not a cFE compatible file.
-** -# The specified file has been created with bad "endianess" (headers should always conform to
-** a big endian format).
-** -# The specified file has become corrupted.
-**
-** The \c ContentType field specified in the event message contains the content type that was found
-** in the specified file.
-**/
+/**
+ * \brief TBL Load Table Invalid File Content ID Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL Load Table failure due to invalid file content ID.
+ */
#define CFE_TBL_FILE_TYPE_ERR_EID 58
-/** \brief 'File subtype for '\%s' is wrong. Subtype = 0x\%08X'
-** \event 'File subtype for '\%s' is wrong. Subtype = 0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when either an Application calls the #CFE_TBL_Load API
-** or a Table Load command has been received and the specified file has a \link #CFE_FS_Header_t
-** cFE Standard File Header \endlink whose \link #CFE_FS_Header_t::SubType Sub Type \endlink
-** is not equal to the expected #CFE_FS_SubType_TBL_IMG. Most likely causes for this are:
-** -# The specified file is not a cFE table image file.
-** -# The specified file has been created with bad "endianess" (headers should always conform to
-** a big endian format).
-** -# The specified file has become corrupted.
-**
-** The \c SubType field specified in the event message contains the sub type that was found
-** in the specified file.
-**/
+/**
+ * \brief TBL Load Table Invalid File Subtype Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL Load Table Failure due to invalid file subtype.
+ */
#define CFE_TBL_FILE_SUBTYPE_ERR_EID 59
-/** \brief 'No working buffers available for table '\%s''
-** \event 'No working buffers available for table '\%s''
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when either a Table Load Command for a Single Buffered Table
-** or a Table Dump Command for a Dump Only Table has been sent AND there are no Shared Buffers
-** available to hold either the load image or the dump image. To free a Shared Buffer, either
-** a previously loaded table image must be activated or aborted OR the operator has to wait for
-** previously dumped Dump Only tables have had a chance to be written to a file (which occurs
-** whenever the cFE Table Services receives a Housekeeping Request).
-**/
+/**
+ * \brief TBL Load Or Dump Table No Working Buffers Available Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL Load or Dump failure due to no working buffers available or internal error. OVERLOADED
+ */
#define CFE_TBL_NO_WORK_BUFFERS_ERR_EID 60
-/** \brief 'Internal Error (Status=0x\%08X)'
-** \event 'Internal Error (Status=0x\%08X)'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Load command was issued and the cFE Table Services
-** is unable to allocate a working table buffer for an unexpected reason.
-**
-** The \c Status field provides the return status from the function that was to provide a working buffer.
-**/
+/**
+ * \brief TBL Load Table Command Get Working Buffer Internal Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_LOAD_CC TBL Load Table Command \endlink failure due to
+ * internal get working buffer error.
+ */
#define CFE_TBL_INTERNAL_ERROR_ERR_EID 61
-/** \brief 'Error creating dump file '\%s', Status=0x\%08X'
-** \event 'Error creating dump file '\%s', Status=0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Dump or Table Registry Dump command was
-** received and the cFE Table Services is unable to create the specified file.
-**
-** The \c Status field provides the return status from the #OS_OpenCreate function call.
-**/
+/**
+ * \brief TBL Write File Creation Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL Write Table or Table Registry File failed to create file. OVERLOADED
+ */
#define CFE_TBL_CREATING_DUMP_FILE_ERR_EID 62
-/** \brief 'Error writing cFE File Header to '\%s', Status=0x\%08X'
-** \event 'Error writing cFE File Header to '\%s', Status=0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Dump or Table Registry Dump command was
-** received and the cFE Table Services is unable to write the standard cFE File Header
-** to the specified file.
-**
-** The \c Status field provides the return status from the #CFE_FS_WriteHeader function call.
-**/
+/**
+ * \brief TBL Write Standard File Header Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL Write Table or Table Registry File failure writing the standard file header. OVERLOADED
+ */
#define CFE_TBL_WRITE_CFE_HDR_ERR_EID 63
-/** \brief 'Error writing Tbl image File Header to '\%s', Status=0x\%08X'
-** \event 'Error writing Tbl image File Header to '\%s', Status=0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Dump command was received and the
-** cFE Table Services is unable to write the standard cFE Table Image Header to the specified file.
-**
-** The \c Status field provides the return status from the #OS_write function call.
-**/
+/**
+ * \brief TBL Write Table File Header Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL Write Table failure writing the table image file header.
+ */
#define CFE_TBL_WRITE_TBL_HDR_ERR_EID 64
-/** \brief 'Error writing Tbl image to '\%s', Status=0x\%08X'
-** \event 'Error writing Tbl image to '\%s', Status=0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Dump command was received and the
-** cFE Table Services is unable to write the contents of the specified Table image to
-** the specified file.
-**
-** The \c Status field provides the return status from the #OS_write function call.
-**/
+/**
+ * \brief TBL Write Table File Data Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL Write Table failure writing the table data.
+ */
#define CFE_TBL_WRITE_TBL_IMG_ERR_EID 65
-/** \brief 'No Inactive Buffer for Table '\%s' present'
-** \event 'No Inactive Buffer for Table '\%s' present'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Dump or a Table Validate command for an
-** Inactive Table Buffer was received and there isn't an Inactive Table Buffer associated
-** with the specified Table.
-**/
+/**
+ * \brief TBL Validate Or Write Table Command No Inactive Buffer Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_VALIDATE_CC TBL Validate Table Command \endlink or
+ * \link #CFE_TBL_DUMP_CC TBL Write Table Command \endlink failure due
+ * to requesting non-existant inactive buffer. OVERLOADED
+ */
#define CFE_TBL_NO_INACTIVE_BUFFER_ERR_EID 66
-/** \brief 'Too many Table Validations have been requested'
-** \event 'Too many Table Validations have been requested'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Validate command was received and there are
-** no more free Validation Result Blocks available. The number of simultaneous validations that
-** can be pending is specified by the configuration parameter #CFE_PLATFORM_TBL_MAX_NUM_VALIDATIONS
-** which is found in the cfe_platform_cfg.h file.
-**
-** Validation Commands lock one of the Validation Result Blocks upon receipt of the validation
-** command until the result of the Validation, performed by the table's owning Application, has
-** been reported in a Table Services Housekeeping Request Message.
-**/
+/**
+ * \brief TBL Validate Table Command Result Storage Exceeded Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_VALIDATE_CC TBL Validate Table Command \endlink failure
+ * due to exceeding result storage.
+ */
#define CFE_TBL_TOO_MANY_VALIDATIONS_ERR_EID 67
-/** \brief 'Error writing Registry to '\%s', Status=0x\%08X'
-** \event 'Error writing Registry to '\%s', Status=0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Registry Dump command was received and the
-** cFE Table Services is unable to write the entire contents of the Table Registry to
-** the specified file.
-**
-** The \c Status field provides the return status from the #OS_write function call.
-**/
+/**
+ * \brief TBL Write Table Registry File Data Failure Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TB Write Table Registry failure writing file data.
+ */
#define CFE_TBL_WRITE_TBL_REG_ERR_EID 68
-/** \brief 'Cannot abort load of '\%s'. No load started.'
-** \event 'Cannot abort load of '\%s'. No load started.'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Abort Load command is received and the command specified
-** table is not currently in the process of being loaded.
-**/
+/**
+ * \brief TBL Abort Table Load No Load Started Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_ABORT_LOAD_CC TBL Abort Table Load Command \endlink failure
+ * due to no load in progress.
+ */
#define CFE_TBL_LOAD_ABORT_ERR_EID 69
-/** \brief 'Cannot activate table '\%s'. No Inactive image available'
-** \event 'Cannot activate table '\%s'. No Inactive image available'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Activate Table command is received and the command specified
-** table does not currently have an inactive buffer associated with it.
-**/
+/**
+ * \brief TBL Activate Table Command No Inactive Buffer Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_ACTIVATE_CC TBL Activate Table Command \endlink failure
+ * due to no associated inactive buffer.
+ */
#define CFE_TBL_ACTIVATE_ERR_EID 70
-/** \brief 'Incomplete load of '\%s' into '\%s' working buffer'
-** \event 'Incomplete load of '\%s' into '\%s' working buffer'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Load Table command is received and the Table Services
-** is unable to load the number of bytes specified in the Table Image Header of the command
-** specified file from the file into the Inactive Buffer.
-**/
+/**
+ * \brief TBL Load Table Incomplete Load Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL Load Table failure due to inability to read the size of data specified in the
+ * table header from file. OVERLOADED
+ */
#define CFE_TBL_FILE_INCOMPLETE_ERR_EID 71
-/** \brief 'Cannot load '\%s' (\%d) at offset \%d in '\%s' (\%d)'
-** \event 'Cannot load '\%s' (\%d) at offset \%d in '\%s' (\%d)'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Load Table command is received and the Table Header in
-** the specified Table Image file identifies a number of bytes with a specified starting offset
-** that would exceed the size of the specified table. For example, if a table had 10 bytes and
-** the Table Header indicated that the Table Image in the file contains 7 bytes that starts at
-** offset 5, then the data content would have exceeded the 10 byte limit of the table.
-**
-** The numbers in parenthesis in the event message text indicate the data size (in bytes) for
-** the specified load file and the registered size for the specified table.
-**/
+/**
+ * \brief TBL Load Table File Exceeds Table Size Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL Load Table failure due to the file header specified offset and/or size of data exceeding the
+ * table size. OVERLOADED
+ */
#define CFE_TBL_LOAD_EXCEEDS_SIZE_ERR_EID 72
-/** \brief 'Table Hdr in '\%s' indicates no data in file'
-** \event 'Table Hdr in '\%s' indicates no data in file'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Load Table command is received and the Table Header in
-** the specified Table Image file claims the file contains no data.
-**/
+/**
+ * \brief TBL Load Table File Zero Length Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL Load Table failure due to the file header specified size of data being zero.
+ */
#define CFE_TBL_ZERO_LENGTH_LOAD_ERR_EID 73
-/** \brief ''\%s' has partial load for uninitialized table '\%s''
-** \event ''\%s' has partial load for uninitialized table '\%s''
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Load Table command is received and the Table Header in
-** the specified Table Image file indicates the starting offset for the table is non-zero and the
-** table has never been previously, completely loaded. Partial Table loads are only allowed after
-** the table has had a successful load.
-**/
+/**
+ * \brief TBL Load Table Uninitialized Partial Load Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL Load Table failure due to attempting a partial load to an uninitialized table. OVERLOADED
+ */
#define CFE_TBL_PARTIAL_LOAD_ERR_EID 74
-/** \brief 'File '\%s' has more data than Tbl Hdr indicates (\%d)'
-** \event 'File '\%s' has more data than Tbl Hdr indicates (\%d)'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Load Table command is received and Table Services is
-** able to locate more data in the specified Table Image file than the Table Header claims is present.
-**/
+/**
+ * \brief TBL Load Table File Excess Data Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL Load Table failure due to the file header specified size of data being smaller than
+ * the actual data contained in the file. OVERLOADED
+ */
#define CFE_TBL_FILE_TOO_BIG_ERR_EID 75
-/** \brief 'Too many Dump Only Table Dumps have been requested'
-** \event 'Too many Dump Only Table Dumps have been requested'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Dump command for a Dump-Only Table was received and there are
-** no more free Dump Only Control Blocks available. The number of simultaneous Dump Only Tables that
-** can be pending is specified by the configuration parameter #CFE_PLATFORM_TBL_MAX_SIMULTANEOUS_LOADS which
-** is found in the cfe_platform_cfg.h file.
-**/
+/**
+ * \brief TBL Write Table Command Dump Only Control Blocks Exceeded Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_DUMP_CC TBL Write Table Command \endlink failure due to exceeding the
+ * allocated number of control blocks available to write a dump only table.
+ */
#define CFE_TBL_TOO_MANY_DUMPS_ERR_EID 76
-/** \brief 'A dump for '\%s' is already pending'
-** \event 'A dump for '\%s' is already pending'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Dump command for a Dump-Only Table was received and
-** Table Services hasn't finished processing the previous Table Dump command for the same Table.
-**/
+/**
+ * \brief TBL Write Table Command Already In Progress Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_DUMP_CC TBL Write Table Command \endlink failure due to a dump already
+ * in progress for the same table.
+ */
#define CFE_TBL_DUMP_PENDING_ERR_EID 77
-/** \brief 'Illegal attempt to activate dump-only table '\%s''
-** \event 'Illegal attempt to activate dump-only table '\%s''
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Activate command for a Dump-Only Table was received.
-** By definition, Dump-Only tables are not allowed to be loaded with any new data.
-**/
+/**
+ * \brief TBL Activate Table Command For Dump Only Table Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_ACTIVATE_CC TBL Activate Table Command \endlink failure due
+ * to table being dump only.
+ */
#define CFE_TBL_ACTIVATE_DUMP_ONLY_ERR_EID 78
-/** \brief 'Attempted to load DUMP-ONLY table '\%s' from '\%s''
-** \event 'Attempted to load DUMP-ONLY table '\%s' from '\%s''
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Load command for a Dump-Only Table was received.
-** By definition, Dump-Only tables are not allowed to be loaded with any new data.
-**/
+/**
+ * \brief TBL Load Table For Dump Only Table Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL Load Table failure due to table being dump only. OVERLOADED
+ */
#define CFE_TBL_LOADING_A_DUMP_ONLY_ERR_EID 79
-/** \brief 'Cmd for Table '\%s' had illegal buffer parameter (0x\%08X)'
-** \event 'Cmd for Table '\%s' had illegal buffer parameter (0x\%08X)'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when either a Table Validate command or a Table Dump Command
-** contains a buffer identifier that does not equal either of the valid values
-** (see #CFE_TBL_DumpCmd_Payload_t::ActiveTableFlag or #CFE_TBL_ValidateCmd_Payload_t::ActiveTableFlag)
-**
-** The parameter in the Event Message indicates (in hex) the value found for the ActiveTableFlag in the command.
-**/
+/**
+ * \brief TBL Validate Or Write Table Command Invalid Buffer Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_VALIDATE_CC TBL Validate Table Command \endlink or
+ * \link #CFE_TBL_DUMP_CC TBL Write Table Command \endlink failure due
+ * to an invalid buffer selection. OVERLOADED
+ */
#define CFE_TBL_ILLEGAL_BUFF_PARAM_ERR_EID 80
-/** \brief 'Cannot activate table '\%s'. Inactive image not Validated'
-** \event 'Cannot activate table '\%s'. Inactive image not Validated'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Activate command is received specifying
-** a Table Image that has not been Validated. If a table has a validation function associated with it
-** (as defined by the owning Application when the Table is first Registered), then the Inactive Image
-** MUST be successfully Validated prior to Activation.
-**/
+/**
+ * \brief TBL Activate Table Command Inactive Image Not Validated Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_ACTIVATE_CC TBL Activate Table Command \endlink failure due
+ * to the inactive image not being validated.
+ */
#define CFE_TBL_UNVALIDATED_ERR_EID 81
-/** \brief ''\%s' found in Table Registry. CDS cannot be deleted until table is unregistered'
-** \event ''\%s' found in Table Registry. CDS cannot be deleted until table is unregistered'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Delete Critical Data Store command is received specifying
-** a Table Image that is still registered. Critical Table Images cannot be removed from the CDS until the
-** table is first removed from the Registry. Unload the owning application and try again.
-**/
+/**
+ * \brief TBL Delete Table CDS Command For Registered Table Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_DELETE_CDS_CC TBL Delete Table CDS Command \endlink failure
+ * due to the table being currently registered.
+ */
#define CFE_TBL_IN_REGISTRY_ERR_EID 82
-/** \brief 'Table '\%s' is in Critical Table Registry but CDS is not tagged as a table'
-** \event 'Table '\%s' is in Critical Table Registry but CDS is not tagged as a table'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Delete Critical Data Store command is received specifying
-** a CDS name for a Critical Data Store that is NOT a critical table image. To delete CDSs that are not
-** Critical Table Images, the Executive Services command #CFE_ES_DELETE_CDS_CC must be used.
-**/
+/**
+ * \brief TBL Delete Table CDS Command Invalid CDS Type Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_DELETE_CDS_CC TBL Delete Table CDS Command \endlink failure
+ * due to CDS being in the table registry but not registered as a table within ES.
+ */
#define CFE_TBL_NOT_CRITICAL_TBL_ERR_EID 83
-/** \brief 'Table '\%s' is not found in Critical Table Registry'
-** \event 'Table '\%s' is not found in Critical Table Registry'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Delete Critical Data Store command is received specifying
-** a table name that cannot be found in the Critical Table Registry. If a Critical Data Store exists with
-** the specified name, then the Critical Table Registry has somehow gotten out of sync with the CDS.
-** Otherwise, the likely cause of this error is a misspelled table name in the command.
-**/
+/**
+ * \brief TBL Delete Table CDS Command Not In Critical Table Registry Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_DELETE_CDS_CC TBL Delete Table CDS Command \endlink failure
+ * due to the table not being in the critical table registry.
+ */
#define CFE_TBL_NOT_IN_CRIT_REG_ERR_EID 84
-/** \brief 'Unable to locate '\%s' in CDS Registry'
-** \event 'Unable to locate '\%s' in CDS Registry'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a Table Delete Critical Data Store command is received specifying
-** a table name that WAS found in the Critical Table Registry but its associated entry in the Critical Data
-** Store Registry was not found. Somehow the two entities have become out of synch.
-**/
+/**
+ * \brief TBL Delete Table CDS Command Not In CDS Registry Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_DELETE_CDS_CC TBL Delete Table CDS Command \endlink failure
+ * due to the table name not found in the CDS registry.
+ */
#define CFE_TBL_CDS_NOT_FOUND_ERR_EID 85
-/** \brief 'Error while deleting '\%s' from CDS, See SysLog.(Err=0x\%08X)'
-** \event 'Error while deleting '\%s' from CDS, See SysLog.(Err=0x\%08X)'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an unexpected error was encountered during the deletion of the CDS.
-** The System Log should have more precise information on the nature of the error.
-**/
+/**
+ * \brief TBL Delete Table CDS Command Internal Error Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_DELETE_CDS_CC TBL Delete Table CDS Command \endlink failure
+ * due to an internal error. See the system log for more information.
+ */
#define CFE_TBL_CDS_DELETE_ERR_EID 86
-/** \brief 'CDS '\%s' owning app is still active'
-** \event 'CDS '\%s' owning app is still active'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an attempt is made to delete a CDS while an application with the
-** same name as the CDS Prefix is still registered in the system. Owning applications must not be active
-** before an associated CDS can be deleted.
-**/
+/**
+ * \brief TBL Delete Table CDS Command App Active Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_DELETE_CDS_CC TBL Delete Table CDS Command \endlink failure
+ * due to the owning application being active.
+ */
#define CFE_TBL_CDS_OWNER_ACTIVE_ERR_EID 87
-/** \brief 'Attempted to load table '\%s' while previous load is still pending'
-** \event 'Attempted to load table '\%s' while previous load is still pending'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an attempt is made to load a table while a previous load is still
-** pending. The most likely cause of this is the owning application is waiting for an appropriate time to
-** load the table with the specified contents. In order to override this load, the user would be required
-** to issue the \link #CFE_TBL_ABORT_LOAD_CC Abort Load Command \endlink.
-**/
+/**
+ * \brief TBL Load Table Command Load Pending Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TBL_LOAD_CC TBL Load Table Command \endlink failed due to a load already pending.
+ */
#define CFE_TBL_LOADING_PENDING_ERR_EID 88
-/** \brief 'Manage Notification Pkt Error(MsgId=0x\%08X, CC=0x\%04X, Param=0x\%08X, Status=0x\%08X)'
-** \event 'Manage Notification Pkt Error(MsgId=0x\%08X, CC=0x\%04X, Param=0x\%08X, Status=0x\%08X)'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a table management notification message
-** fails to be sent via the software bus.
-**
-** The \c MsgId is the message ID of the table management notification message that was attempted to be sent,
-** the \c CC is the command code, the \c Param is the application specified command parameter and the \c Status
-** is the error code returned.
-**/
+/**
+ * \brief TBL Send Notification Transmit Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL send notification transmit message failure.
+ */
#define CFE_TBL_FAIL_NOTIFY_SEND_ERR_EID 89
-/** \} */
-
-/** \name API Informational Event Message IDs */
-/** \{ */
-
-/** \brief 'Successfully loaded '\%s' from '\%s''
-** \event 'Successfully loaded '\%s' from '\%s''
-**
-** \par Type: DEBUG (the first time) and INFORMATION (normally)
-**
-** \par Cause:
-**
-** This event message is generated when a Table is successfully updated by its owning Application
-** with the contents of the Application specified file or memory area. This Event Message only
-** appears when an Application successfully calls the #CFE_TBL_Load API.
-**/
-#define CFE_TBL_LOAD_SUCCESS_INF_EID 35
-/** \brief '\%s validation successful for Inactive '\%s''
-** \event '\%s validation successful for Inactive '\%s''
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated when a Table Image is successfully validated by its owning
-** Application via the Validation function specified by the owning Application when the table
-** was first registered.
-**/
-#define CFE_TBL_VALIDATION_INF_EID 36
-
-/** \brief '\%s Successfully Updated '\%s''
-** \event '\%s Successfully Updated '\%s''
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated when a Table's Active Buffer is successfully updated with the contents
-** of its Inactive Buffer.
-**/
-#define CFE_TBL_UPDATE_SUCCESS_INF_EID 37
-
-/** \brief 'Successfully removed '\%s' from CDS'
-** \event 'Successfully removed '\%s' from CDS'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated when a Critical Table's CDS has been successfully deleted.
-**/
-#define CFE_TBL_CDS_DELETED_INFO_EID 38
-/** \} */
-
-/** \name API Error Event Message IDs */
-/** \{ */
-/** \brief '\%s Failed to Register '\%s', Status=0x\%08X'
-** \event '\%s Failed to Register '\%s', Status=0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Application calls #CFE_TBL_Register unsuccessfully.
-**
-** The \c Status field of the Event Message can be used to identify the reason for the failure
-** by looking it up in the cfe_error.h file
-**/
+/**
+ * \brief TBL Register Table Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL table registration failure. See system log for more information.
+ */
#define CFE_TBL_REGISTER_ERR_EID 90
-/** \brief '\%s Failed to Share '\%s', Status=0x\%08X'
-** \event '\%s Failed to Share '\%s', Status=0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Application calls #CFE_TBL_Share unsuccessfully.
-**
-** The \c Status field of the Event Message can be used to identify the reason for the failure
-** by looking it up in the cfe_error.h file
-**/
+/**
+ * \brief TBL Share Table Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL share table failure. See system log for more information.
+ */
#define CFE_TBL_SHARE_ERR_EID 91
-/** \brief '\%s Failed to Unregister '\%s', Status=0x\%08X'
-** \event '\%s Failed to Unregister '\%s', Status=0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Application calls #CFE_TBL_Unregister unsuccessfully.
-**
-** The \c Status field of the Event Message can be used to identify the reason for the failure
-** by looking it up in the cfe_error.h file
-**/
+/**
+ * \brief TBL Unregister Table Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL unregister table failure. See system log for more information.
+ */
#define CFE_TBL_UNREGISTER_ERR_EID 92
-/* TODO: document see https://github.com/nasa/cFE/issues/661 */
+/**
+ * \brief TBL Validation Function Invalid Return Code Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid table validation function return code.
+ */
#define CFE_TBL_LOAD_VAL_ERR_EID 93
-/** \brief '\%s Failed to Load '\%s' (Invalid Source Type)"
-** \event '\%s Failed to Load '\%s' (Invalid Source Type)"
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Application calls #CFE_TBL_Load with a bad value for
-** the \c SrcType parameter. The \c SrcType must be one of the values specified by #CFE_TBL_SrcEnum_t.
-**/
+/**
+ * \brief TBL Load Table API Invalid Source Type Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_TBL_Load API valid due to invalid source type.
+ */
#define CFE_TBL_LOAD_TYPE_ERR_EID 94
-/** \brief '\%s Failed to Update '\%s', Status=0x\%08X"
-** \event '\%s Failed to Update '\%s', Status=0x\%08X"
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Application calls #CFE_TBL_Update (or, via an internal call,
-** the #CFE_TBL_Manage) API and the Table fails to properly update.
-**
-** The \c Status parameter in the Event Message can be used to identify the reason for the failure
-** by looking it up in the cfe_error.h file.
-**/
+/**
+ * \brief TBL Update Table Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL update table failure due to an internal error. OVERLOADED
+ */
#define CFE_TBL_UPDATE_ERR_EID 95
-/** \brief '\%s validation failed for Inactive '\%s', Status=0x\%08X'
-** \event '\%s validation failed for Inactive '\%s', Status=0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an Application calls #CFE_TBL_Validate (or, via an internal call,
-** the #CFE_TBL_Manage) API and the Table fails its Validation.
-**
-** The \c Status parameter in the Event Message contains the status code returned by the Table's
-** Validation function as defined by the owning Application when the Table was Registered.
-**/
+/**
+ * \brief TBL Validate Table Validation Failed Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * TBL validate table function indicates validation failed. OVERLOADED
+ */
#define CFE_TBL_VALIDATION_ERR_EID 96
-/** \brief 'Unable to verify Spacecraft ID for '\%s', ID = 0x\%08X'
-** \event 'Unable to verify Spacecraft ID for '\%s', ID = 0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when either an Application calls the #CFE_TBL_Load API or a Table
-** Load command has been received and the specified table file has failed Spacecraft ID validation.
-** Verification of Spacecraft ID in table files is enabled/disabled via #CFE_PLATFORM_TBL_VALID_SCID_COUNT,
-** defined in the platform configuration header file. This event message can only be generated if
-** #CFE_PLATFORM_TBL_VALID_SCID_COUNT has a non-zero value and the table file has a \link #CFE_FS_Header_t
-** cFE Standard File Header \endlink whose \link #CFE_FS_Header_t::SpacecraftID Spacecraft ID \endlink
-** does not match one of the values defined for Spacecraft ID verification in the platform config file.
-** The most likely causes for this error are:
-** -# The specified table file is not intended for this spacecraft.
-** -# The specified table file has been created with bad "endianess" (headers should always conform to
-** a big endian format).
-** -# The specified table file has become corrupted.
-** -# The definition for #CFE_PLATFORM_TBL_VALID_SCID_COUNT is not large enough to include all of the valid
-** Spacecraft ID entries in the platform config file.
-** -# There is no entry for this Spacecraft ID in the platform config file list of valid Spacecraft ID's.
-**
-** The \c ID field specified in the event message contains the Spacecraft ID that was found
-** in the specified table file.
-**/
+/**
+ * \brief TBL Read Header Invalid Spacecraft ID Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid spacecraft ID in table file header.
+ */
#define CFE_TBL_SPACECRAFT_ID_ERR_EID 97
-/** \brief 'Unable to verify Processor ID for '\%s', ID = 0x\%08X'
-** \event 'Unable to verify Processor ID for '\%s', ID = 0x\%08X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when either an Application calls the #CFE_TBL_Load API or a Table
-** Load command has been received and the specified table file has failed Processor ID validation.
-** Verification of Processor ID in table files is enabled/disabled via #CFE_PLATFORM_TBL_VALID_PRID_COUNT,
-** defined in the platform configuration header file. This event message can only be generated if
-** #CFE_PLATFORM_TBL_VALID_PRID_COUNT has a non-zero value and the table file has a \link #CFE_FS_Header_t
-** cFE Standard File Header \endlink whose \link #CFE_FS_Header_t::ProcessorID Processor ID \endlink
-** does not match one of the values defined for Processor ID verification in the platform config file.
-** The most likely causes for this error are:
-** -# The specified table file is not intended for this processor.
-** -# The specified table file has been created with bad "endianess" (headers should always conform to
-** a big endian format).
-** -# The specified table file has become corrupted.
-** -# The definition for #CFE_PLATFORM_TBL_VALID_PRID_COUNT is not large enough to include all of the valid
-** Processor ID entries in the platform config file.
-** -# There is no entry for this Processor ID in the platform config file list of valid Processor ID's.
-**
-** The \c ID field specified in the event message contains the Processor ID that was found
-** in the specified table file.
-**/
+/**
+ * \brief TBL Read Header Invalid Processor ID Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid processor ID in table file header.
+ */
#define CFE_TBL_PROCESSOR_ID_ERR_EID 98
-/** \brief Attempted to load Dump Only Tbl '%s'
-** \event Attempted to load Dump Only Tbl '%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an application attempts to load a dump-only table.
-**/
-#define CFE_TBL_LOAD_DUMPONLY_ERR_EID 99
-
-/** \brief Load already in progress for '%s'
-** \event Load already in progress for '%s'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when an application attempts to load a table already
-** in progress. Likely due to a race condition.
-**/
+/**
+ * \brief TBL Load Table API Load Already In Progress Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_TBL_Load API failure due to load already in progress.
+ */
#define CFE_TBL_LOAD_IN_PROGRESS_ERR_EID 100
-/** \brief Filename is too long ('%s' (%lu) > %lu)
-** \event Filename is too long ('%s' (%lu) > %lu)
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** The filename provided for the table file is too long (exceeding OS_MAX_PATH_LEN - 1).
-**/
+/**
+ * \brief TBL Load Table Filename Too Long Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Load table filename too long.
+ */
#define CFE_TBL_LOAD_FILENAME_LONG_ERR_EID 101
-/** \brief table name mismatch (exp=%s, tblfilhdr=%s)
-** \event table name mismatch (exp=%s, tblfilhdr=%s)
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** The table name in the table file header does not match the specified table name.
-**/
+/**
+ * \brief TBL Load Table Name Mismatch Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Load table name in the table file header does not match the specified table name.
+ */
#define CFE_TBL_LOAD_TBLNAME_MISMATCH_ERR_EID 102
-/** \brief No access to Tbl handle=%d
-** \event No access to Tbl handle=%d
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** The application ID does not have access to the table handle.
-**/
+/**
+ * \brief TBL Load Table API Access Violation Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * #CFE_TBL_Load API failure due to the application not owning the table.
+ */
#define CFE_TBL_HANDLE_ACCESS_ERR_EID 103
-
-/** \} */
+/**\}*/
#endif /* CFE_TBL_EVENTS_H */
diff --git a/modules/time/fsw/inc/cfe_time_events.h b/modules/time/fsw/inc/cfe_time_events.h
index ae43e9b3b..bbd6d4d50 100644
--- a/modules/time/fsw/inc/cfe_time_events.h
+++ b/modules/time/fsw/inc/cfe_time_events.h
@@ -21,602 +21,435 @@
/**
* @file
*
- * Purpose:
- * cFE Time Services (Time) Event IDs
- *
- * Design Notes:
- *
- * References:
- * Flight Software Branch C Coding Standard Version 1.0a
- *
+ * cFE Time Services Event IDs
*/
#ifndef CFE_TIME_EVENTS_H
#define CFE_TIME_EVENTS_H
-/* **************************
-** ****** Maximum EID. ******
-** **************************
-** The EID's below may not necessarily be in order, so it can be difficult to
-** determine what the next EID is to use. When you add EID's, start with MAX_EID + 1
-** and when you're done adding, set this to the highest EID you used. It may
-** be worthwhile to, on occasion, re-number the EID's to put them back in order.
-*/
-#define CFE_TIME_MAX_EID 49
+/**
+ * \name TIME event IDs
+ */
+/**\{*/
-/*
-** Event message ID's...
-*/
-/** \brief 'cFE TIME Initialized'
-** \event 'cFE TIME Initialized'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always automatically issued when the Time Services
-** Task completes its Initialization.
-**/
-#define CFE_TIME_INIT_EID 1 /* start up message "informational" */
+/**
+ * \brief TIME Initialization Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * Time Services Task Initialization complete.
+ */
+#define CFE_TIME_INIT_EID 1
-/** \brief 'No-op command'
-** \event 'No-op command'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is always automatically issued in response
-** to a cFE Time Services \link #CFE_TIME_NOOP_CC NO-OP command \endlink
-**/
-#define CFE_TIME_NOOP_EID 4 /* processed command "informational" */
+/**
+ * \brief TIME No-op Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_NOOP_CC TIME NO-OP Command \endlink success.
+ */
+#define CFE_TIME_NOOP_EID 4
-/** \brief 'Reset Counters command'
-** \event 'Reset Counters command'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is always automatically issued in response
-** to a cFE Time Services \link #CFE_TIME_RESET_COUNTERS_CC Reset Counters command \endlink
-**/
+/**
+ * \brief TIME Reset Counters Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_RESET_COUNTERS_CC TIME Reset Counters Command \endlink success.
+ */
#define CFE_TIME_RESET_EID 5
-/** \brief 'Request diagnostics command'
-** \event 'Request diagnostics command'
-**
-** \par Type: DEBUG
-**
-** \par Cause:
-**
-** This event message is always automatically issued in response
-** to a cFE Time Services \link #CFE_TIME_SEND_DIAGNOSTIC_TLM_CC Request Diagnostics command \endlink
-**/
+/**
+ * \brief TIME Request Diagnostics Command Success Event ID
+ *
+ * \par Type: DEBUG
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SEND_DIAGNOSTIC_TLM_CC TIME Request Diagnostics Command \endlink success.
+ */
#define CFE_TIME_DIAG_EID 6
-/** \brief 'Set Clock State = \%s'
-** \event 'Set Clock State = \%s'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion
-** of a cFE Time Services \link #CFE_TIME_SET_STATE_CC Set Time State command \endlink
-**
-** The \c '\%s' field will identify whether the command specified
-** \c VALID, \c INVALID, or \c FLYWHEEL.
-**/
+/**
+ * \brief TIME Set Time State Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_STATE_CC TIME Set Time State Command \endlink success.
+ */
#define CFE_TIME_STATE_EID 7
-/** \brief 'Set Time Source = \%s'
-** \event 'Set Time Source = \%s'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion
-** of a cFE Time Services \link #CFE_TIME_SET_SOURCE_CC Set Time Source command \endlink
-**
-** The \c '\%s' field will identify whether the command specified
-** \c INTERNAL, or \c EXTERNAL.
-**/
+/**
+ * \brief TIME Set Time Source Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_SOURCE_CC TIME Set Time Source Command \endlink success.
+ */
#define CFE_TIME_SOURCE_EID 8
-/** \brief 'Set Tone Source = \%s'
-** \event 'Set Tone Source = \%s'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion
-** of a cFE Time Services \link #CFE_TIME_SET_SIGNAL_CC Set Clock Signal command \endlink
-**
-** The \c '\%s' field will identify whether the command specified
-** \c PRIMARY, or \c REDUNDANT.
-**/
+/**
+ * \brief TIME Set Tone Source Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_SIGNAL_CC TIME Set Clock Tone Source Command \endlink success.
+ */
#define CFE_TIME_SIGNAL_EID 9
-/** \brief 'Set Tone Delay -- secs = \%d, usecs = \%d, ssecs = 0x\%X, dir = \%d'
-** \event 'Set Tone Delay -- secs = \%d, usecs = \%d, ssecs = 0x\%X, dir = \%d'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion
-** of either a cFE Time Services
-** \link #CFE_TIME_ADD_DELAY_CC Add Time Delay \endlink OR a
-** \link #CFE_TIME_SUB_DELAY_CC Subtract Time Delay command \endlink
-**
-** The \c secs field specifies the new delay (in seconds), the \c usecs
-** field specifies the delay in micro-seconds, the \c ssecs field is
-** the micro-seconds field converted to Spacecraft Time sub-seconds and
-** the \c dir field identifies the direction of the delay. The direction
-** can be either #CFE_TIME_AdjustDirection_ADD or #CFE_TIME_AdjustDirection_SUBTRACT.
-**/
+/**
+ * \brief TIME Add or Subtract Delay Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_ADD_DELAY_CC TIME Add Time Delay Command \endlink OR a
+ * \link #CFE_TIME_SUB_DELAY_CC Subtract Time Delay Command \endlink success.
+ */
#define CFE_TIME_DELAY_EID 11
-/** \brief 'Set Time -- secs = \%d, usecs = \%d, ssecs = 0x\%X'
-** \event 'Set Time -- secs = \%d, usecs = \%d, ssecs = 0x\%X'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion
-** of a cFE Time Services \link #CFE_TIME_SET_TIME_CC Set Time command \endlink
-**
-** The \c secs field specifies the new spacecraft time (in seconds), the \c usecs
-** field specifies the spacecraft time micro-seconds, the \c ssecs field is
-** the micro-seconds field converted to Spacecraft Time sub-seconds
-**/
+/**
+ * \brief TIME Set Time Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_TIME_CC TIME Set Time Command \endlink success.
+ */
#define CFE_TIME_TIME_EID 12
-/** \brief 'Set MET -- secs = \%d, usecs = \%d, ssecs = 0x\%X'
-** \event 'Set MET -- secs = \%d, usecs = \%d, ssecs = 0x\%X'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion
-** of a cFE Time Services \link #CFE_TIME_SET_MET_CC Set Mission Elapsed Time command \endlink
-**
-** The \c secs field specifies the new MET (in seconds), the \c usecs
-** field specifies the MET micro-seconds, the \c ssecs field is
-** the micro-seconds field converted to Spacecraft Time sub-seconds
-**/
+/**
+ * \brief TIME Set Mission Elapsed Time Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_MET_CC TIME Set Mission Elapsed Time Command \endlink success.
+ */
#define CFE_TIME_MET_EID 13
-/** \brief 'Set STCF -- secs = \%d, usecs = \%d, ssecs = 0x\%X'
-** \event 'Set STCF -- secs = \%d, usecs = \%d, ssecs = 0x\%X'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion
-** of a cFE Time Services \link #CFE_TIME_SET_STCF_CC Set Spacecraft Time
-** Correlation Factor command \endlink
-**
-** The \c secs field specifies the new STCF (in seconds), the \c usecs
-** field specifies the STCF micro-seconds, the \c ssecs field is
-** the micro-seconds field converted to Spacecraft Time sub-seconds.
-**/
+/**
+ * \brief TIME Set Spacecraft Time Correlation Factor Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_STCF_CC TIME Set Spacecraft Time Correlation Factor Command \endlink success.
+ */
#define CFE_TIME_STCF_EID 14
-/** \brief 'STCF Adjust -- secs = \%d, usecs = \%d, ssecs = 0x\%X, dir[1=Positive, 2=Negative] = \%d'
-** \event 'STCF Adjust -- secs = \%d, usecs = \%d, ssecs = 0x\%X, dir[1=Positive, 2=Negative] = \%d'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion
-** of any of the following cFE Time Services STCF Adjustment Commands:
-** - \link #CFE_TIME_ADD_ADJUST_CC Add Single STCF Adjustment command \endlink
-** - \link #CFE_TIME_SUB_ADJUST_CC Subtract Single STCF Adjustment command \endlink
-**
-** The \c secs field specifies the number of seconds the STCF is to be adjusted by,
-** the \c usecs field specifies the number of micro-seconds, the \c ssecs field is
-** the micro-seconds field converted to Spacecraft Time sub-seconds and the \c dir
-** field identifies whether the adjustment was added or subtracted. The direction
-** can be either #CFE_TIME_AdjustDirection_ADD or #CFE_TIME_AdjustDirection_SUBTRACT.
-**/
+/**
+ * \brief TIME Add or Subtract Single STCF Adjustment Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_ADD_ADJUST_CC TIME Add Single STCF Adjustment Command \endlink OR
+ * \link #CFE_TIME_SUB_ADJUST_CC TIME Subtract Single STCF Adjustment Command \endlink success.
+ */
#define CFE_TIME_DELTA_EID 15
-/** \brief 'STCF 1Hz Adjust -- secs = \%d, ssecs = 0x\%X, dir = \%d'
-** \event 'STCF 1Hz Adjust -- secs = \%d, ssecs = 0x\%X, dir = \%d'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion
-** of any of the following cFE Time Services STCF Adjustment Commands:
-** - \link #CFE_TIME_ADD_1HZ_ADJUSTMENT_CC Add STCF Adjustment each second command \endlink
-** - \link #CFE_TIME_SUB_1HZ_ADJUSTMENT_CC Subtract STCF Adjustment each second command \endlink
-**
-** The \c secs field specifies the number of seconds the STCF is to be adjusted by,
-** the \c ssecs field specifies the number of sub-seconds (1/2^32 seconds) the STCF
-** is to be adjusted by and the \c dir field identifies whether the adjustment was
-** added or subtracted. The direction value can be either #CFE_TIME_AdjustDirection_ADD or
-** #CFE_TIME_AdjustDirection_SUBTRACT.
-**/
+/**
+ * \brief TIME Add or Subtract STCF Adjustment Each Second Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_ADD_1HZ_ADJUSTMENT_CC TIME Add STCF Adjustment Each Second Command \endlink OR
+ * \link #CFE_TIME_SUB_1HZ_ADJUSTMENT_CC TIME Subtract STCF Adjustment Each Second Command \endlink success.
+ */
#define CFE_TIME_1HZ_EID 16
-/** \brief 'Set Leap Seconds = \%d'
-** \event 'Set Leap Seconds = \%d'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated upon successful completion
-** of the \link #CFE_TIME_SET_LEAP_SECONDS_CC Set Leap Seconds command \endlink
-**
-** The \c \%d field contains the number of seconds the Spacecraft's Leap Seconds
-** has been set to.
-**/
+/**
+ * \brief TIME Set Leap Seconds Command Success Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_LEAP_SECONDS_CC TIME Set Leap Seconds Command \endlink success.
+ */
#define CFE_TIME_LEAPS_EID 17
-/** \brief 'Start FLYWHEEL'
-** \event 'Start FLYWHEEL'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated whenever the Time Services enters FLYWHEEL mode.
-**/
-#define CFE_TIME_FLY_ON_EID 20 /* flywheel state "informational" */
+/**
+ * \brief TIME Entered FLYWHEEL Mode Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * TIME Entered FLYWHEEL Mode.
+ */
+#define CFE_TIME_FLY_ON_EID 20
-/** \brief 'Stop FLYWHEEL'
-** \event 'Stop FLYWHEEL'
-**
-** \par Type: INFORMATION
-**
-** \par Cause:
-**
-** This event message is generated whenever the Time Services exits FLYWHEEL mode.
-**/
+/**
+ * \brief TIME Exited FLYWHEEL Mode Event ID
+ *
+ * \par Type: INFORMATION
+ *
+ * \par Cause:
+ *
+ * TIME Exited FLYWHEEL Mode.
+ */
#define CFE_TIME_FLY_OFF_EID 21
-#define CFE_TIME_EXIT_ERR_EID 25 /* task termination "error" */
-
-/** \brief 'Invalid message ID -- ID = 0x\%X'
-** \event 'Invalid message ID -- ID = 0x\%X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** a message from the software bus that is not one of Time Services
-** recognized messages.
-**
-** The \c ID field specifies, in hex, the message ID of the inappropriately
-** received message.
-**/
-#define CFE_TIME_ID_ERR_EID 26 /* invalid command packet "error" */
+/**
+ * \brief TIME Invalid Message ID Received Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid message ID received on the TIME message pipe.
+ */
+#define CFE_TIME_ID_ERR_EID 26
-/** \brief 'Invalid command code -- ID = 0x\%X, CC = \%d'
-** \event 'Invalid command code -- ID = 0x\%X, CC = \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** a message from the software bus that contains a unrecognized command
-** code in its header..
-**
-** The \c ID field specifies, in hex, the message ID of the message containing
-** the unrecognized command code, identified, in decimal, by the \c CC field.
-**/
+/**
+ * \brief TIME Invalid Command Code Received Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid command code for message ID #CFE_TIME_CMD_MID received on the TIME message pipe.
+ */
#define CFE_TIME_CC_ERR_EID 27
-/** \brief 'Invalid Clock State = 0x\%X'
-** \event 'Invalid Clock State = 0x\%X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** a \link #CFE_TIME_SET_STATE_CC Set Clock State Command \endlink
-** that contains a desired clock state that is none of the following:
-** - #CFE_TIME_ClockState_INVALID
-** - #CFE_TIME_ClockState_VALID
-** - #CFE_TIME_ClockState_FLYWHEEL
-**
-** The \c State field specifies, in hex, the state value received
-** in the command message.
-**/
-#define CFE_TIME_STATE_ERR_EID 30 /* processed command "error" */
+/**
+ * \brief TIME Set Clock State Command Invalid State Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_STATE_CC TIME Set Clock State Command \endlink failed due to invalid state requested.
+ */
+#define CFE_TIME_STATE_ERR_EID 30
-/** \brief 'Invalid Time Source = 0x\%X'
-** \event 'Invalid Time Source = 0x\%X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** a \link #CFE_TIME_SET_SOURCE_CC Set Clock Source Command \endlink
-** that contains a desired clock source that is none of the following:
-** - #CFE_TIME_SourceSelect_INTERNAL
-** - #CFE_TIME_SourceSelect_EXTERNAL
-**
-** The \c Source field specifies, in hex, the source value received
-** in the command message.
-**/
+/**
+ * \brief TIME Set Clock Source Command Invalid Source Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_SOURCE_CC TIME Set Clock Source Command \endlink failed due to invalid source requested.
+ */
#define CFE_TIME_SOURCE_ERR_EID 31
-/** \brief 'Invalid Tone Source = 0x\%X'
-** \event 'Invalid Tone Source = 0x\%X'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** a \link #CFE_TIME_SET_SIGNAL_CC Set Clock Signal Command \endlink
-** that contains a desired clock source that is none of the following:
-** - #CFE_TIME_ToneSignalSelect_PRIMARY
-** - #CFE_TIME_ToneSignalSelect_REDUNDANT
-**
-** The \c Source field specifies, in hex, the signal source value received
-** in the command message.
-**/
+/**
+ * \brief TIME Set Clock Tone Source Command Invalid Source Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_SIGNAL_CC Set Clock Tone Source Command \endlink failed due to invalid source requested.
+ */
#define CFE_TIME_SIGNAL_ERR_EID 32
-/** \brief 'Invalid Tone Delay -- secs = \%d, usecs = \%d'
-** \event 'Invalid Tone Delay -- secs = \%d, usecs = \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** either a \link #CFE_TIME_ADD_DELAY_CC Add Tone Delay Command \endlink
-** OR a \link #CFE_TIME_SUB_DELAY_CC Subtract Tone Delay Command \endlink
-** that contains a microsecond field that is greater than or equal to
-** 1000000.
-**
-** The \c secs field specifies, in decimal, the tone signal delay in seconds
-** and the \c usecs field specifies, in decimal, the micro-second delay that
-** was in error.
-**/
+/**
+ * \brief TIME Add or Subtract Tone Delay Command Invalid Time Value Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_ADD_DELAY_CC TIME Add Tone Delay Command \endlink OR
+ * \link #CFE_TIME_SUB_DELAY_CC TIME Subtract Tone Delay Command \endlink falure
+ * due to an invalid time value.
+ */
#define CFE_TIME_DELAY_ERR_EID 33
-/** \brief 'Invalid Time -- secs = \%d, usecs = \%d'
-** \event 'Invalid Time -- secs = \%d, usecs = \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** a \link #CFE_TIME_SET_TIME_CC Set Spacecraft Time Command \endlink
-** that contains a microsecond field that is greater than or equal to
-** 1,000,000.
-**
-** The \c secs field specifies, in decimal, the spacecraft time in seconds
-** and the \c usecs field specifies, in decimal, the micro-second field of
-** the spacecraft time that was in error.
-**/
+/**
+ * \brief TIME Set Spacecraft Time Command Invalid Time Value Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_TIME_CC TIME Set Spacecraft Time Command \endlink failure
+ * due to an invalid time value.
+ */
#define CFE_TIME_TIME_ERR_EID 34
-/** \brief 'Invalid MET -- secs = \%d, usecs = \%d'
-** \event 'Invalid MET -- secs = \%d, usecs = \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** a \link #CFE_TIME_SET_MET_CC Set Mission Elapsed Time Command \endlink
-** that contains a microsecond field that is greater than or equal to
-** 1,000,000.
-**
-** The \c secs field specifies, in decimal, the MET in seconds
-** and the \c usecs field specifies, in decimal, the micro-second field of
-** the MET that was in error.
-**/
+/**
+ * \brief TIME Set Mission Elapsed Time Command Invalid Time Value Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_MET_CC TIME Set Mission Elapsed Time Command \endlink failure
+ * due to an invalid time value.
+ */
#define CFE_TIME_MET_ERR_EID 35
-/** \brief 'Invalid STCF -- secs = \%d, usecs = \%d'
-** \event 'Invalid STCF -- secs = \%d, usecs = \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** a \link #CFE_TIME_SET_STCF_CC Set Spacecraft Time Correlation Factor Command \endlink
-** that contains a microsecond field that is greater than or equal to
-** 1,000,000.
-**
-** The \c secs field specifies, in decimal, the STCF in seconds
-** and the \c usecs field specifies, in decimal, the micro-second field of
-** the STCF that was in error.
-**/
+/**
+ * \brief TIME Set Spacecraft Time Correlation Factor Command Invalid Time Value Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_STCF_CC TIME Set Spacecraft Time Correlation Factor Command \endlink
+ * failure due to an invalid time value.
+ */
#define CFE_TIME_STCF_ERR_EID 36
-/** \brief 'Invalid STCF Adjust -- secs = \%d, usecs = \%d, dir[1=Positive, 2=Negative] = \%d'
-** \event 'Invalid STCF Adjust -- secs = \%d, usecs = \%d, dir[1=Positive, 2=Negative] = \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** either a \link #CFE_TIME_ADD_ADJUST_CC Add Single STCF Adjustment Command \endlink
-** OR a \link #CFE_TIME_SUB_ADJUST_CC Subtract Single STCF Adjustment command \endlink
-** that contains a microsecond field that is greater than or equal to
-** 1,000,000.
-**
-** The \c secs field specifies the number of seconds the STCF is to be adjusted by,
-** the \c usecs field specifies the number of micro-seconds that was in error, the \c dir
-** field identifies whether the adjustment was to be added or subtracted. The direction
-** can be either #CFE_TIME_AdjustDirection_ADD or #CFE_TIME_AdjustDirection_SUBTRACT.
-**/
+/**
+ * \brief TIME Add or Subtract Single STCF Adjustment Command Invalid Time Value Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_ADD_ADJUST_CC TIME Add Single STCF Adjustment Command \endlink
+ * OR \link #CFE_TIME_SUB_ADJUST_CC TIME Subtract Single STCF Adjustment Command \endlink
+ * falure due to an invalid time value.
+ */
#define CFE_TIME_DELTA_ERR_EID 37
-/** (obsolete - unused)
- **/
-#define CFE_TIME_1HZ_ERR_EID 38
+/**
+ * \brief TIME Set Clock Source Command Incompatible Mode Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_SOURCE_CC TIME Set Clock Source Command \endlink failure
+ * due to being in an incompatible mode.
+ */
+#define CFE_TIME_SOURCE_CFG_EID 40
-/** \brief 'Set Source commands invalid without CFE_PLATFORM_TIME_CFG_SOURCE set to true'
-** \event 'Set Source commands invalid without CFE_PLATFORM_TIME_CFG_SOURCE set to true'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** a \link #CFE_TIME_SET_SOURCE_CC Set Clock Source Command \endlink
-** and the Time Services configuration parameter #CFE_PLATFORM_TIME_CFG_SOURCE has
-** not been set to true in the cfe_platform_cfg.h file.
-**/
-#define CFE_TIME_SOURCE_CFG_EID 40 /* cmd disabled per cfg "error" */
-
-/** \brief 'Set Signal commands invalid without CFE_PLATFORM_TIME_CFG_SIGNAL set to true'
-** \event 'Set Signal commands invalid without CFE_PLATFORM_TIME_CFG_SIGNAL set to true'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** a \link #CFE_TIME_SET_SIGNAL_CC Set Clock Signal Command \endlink
-** and the Time Services configuration parameter #CFE_PLATFORM_TIME_CFG_SIGNAL has
-** not been set to true in the cfe_platform_cfg.h file.
-**/
+/**
+ * \brief TIME Set Clock Signal Command Incompatible Mode Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_SIGNAL_CC TIME Set Clock Signal Command \endlink failure
+ * due to being in an incompatible mode.
+ */
#define CFE_TIME_SIGNAL_CFG_EID 41
-/** \brief 'Set Delay commands invalid without CFE_PLATFORM_TIME_CFG_CLIENT set to true'
-** \event 'Set Delay commands invalid without CFE_PLATFORM_TIME_CFG_CLIENT set to true'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** either a \link #CFE_TIME_ADD_DELAY_CC Add Tone Delay Command \endlink
-** OR a \link #CFE_TIME_SUB_DELAY_CC Subtract Tone Delay Command \endlink
-** and the Time Services configuration parameter #CFE_PLATFORM_TIME_CFG_CLIENT has
-** not been set to true in the cfe_platform_cfg.h file.
-**/
+/**
+ * \brief TIME Add or Subtract Tone Delay Command Incompatible Mode Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_ADD_DELAY_CC TIME Add Tone Delay Command \endlink OR
+ * \link #CFE_TIME_SUB_DELAY_CC TIME Subtract Tone Delay Command \endlink failure
+ * due to being in an incompatible mode.
+ */
#define CFE_TIME_DELAY_CFG_EID 42
-/** \brief 'Set Time commands invalid without CFE_PLATFORM_TIME_CFG_SERVER set to true'
-** \event 'Set Time commands invalid without CFE_PLATFORM_TIME_CFG_SERVER set to true'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** a \link #CFE_TIME_SET_TIME_CC Set Spacecraft Time Command \endlink
-** and the Time Services configuration parameter #CFE_PLATFORM_TIME_CFG_SERVER has
-** not been set to true in the cfe_platform_cfg.h file.
-**/
+/**
+ * \brief TIME Set Spacecraft Time Command Incompatible Mode Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_TIME_CC TIME Set Spacecraft Time Command \endlink failure
+ * due to being in an incompatible mode.
+ */
#define CFE_TIME_TIME_CFG_EID 43
-/** \brief 'Set MET commands invalid without CFE_PLATFORM_TIME_CFG_SERVER set to true'
-** \event 'Set MET commands invalid without CFE_PLATFORM_TIME_CFG_SERVER set to true'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** a \link #CFE_TIME_SET_MET_CC Set Mission Elapsed Time Command \endlink
-** and the Time Services configuration parameter #CFE_PLATFORM_TIME_CFG_SERVER has
-** not been set to true in the cfe_platform_cfg.h file.
-**/
+/**
+ * \brief TIME Set Mission Elapsed Time Command Incompatible Mode Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_MET_CC TIME Set Mission Elapsed Time Command \endlink failure
+ * due to being in an incompatible mode.
+ */
#define CFE_TIME_MET_CFG_EID 44
-/** \brief 'Set STCF commands invalid without CFE_PLATFORM_TIME_CFG_SERVER set to true'
-** \event 'Set STCF commands invalid without CFE_PLATFORM_TIME_CFG_SERVER set to true'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** a \link #CFE_TIME_SET_STCF_CC Set Spacecraft Time Correlation Factor Command \endlink
-** and the Time Services configuration parameter #CFE_PLATFORM_TIME_CFG_SERVER has
-** not been set to true in the cfe_platform_cfg.h file.
-**/
+/**
+ * \brief TIME Set Spacecraft Time Correlation Factor Command Incompatible Mode Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_STCF_CC TIME Set Spacecraft Time Correlation Factor Command \endlink failure
+ * due to being in an incompatible mode.
+ */
#define CFE_TIME_STCF_CFG_EID 45
-/** \brief 'Set Leaps commands invalid without CFE_PLATFORM_TIME_CFG_SERVER set to true'
-** \event 'Set Leaps commands invalid without CFE_PLATFORM_TIME_CFG_SERVER set to true'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** a \link #CFE_TIME_SET_LEAP_SECONDS_CC Set Leap Seconds Command \endlink
-** and the Time Services configuration parameter #CFE_PLATFORM_TIME_CFG_SERVER has
-** not been set to true in the cfe_platform_cfg.h file.
-**/
+/**
+ * \brief TIME Set Leap Seconds Command Incompatible Mode Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_SET_LEAP_SECONDS_CC TIME Set Leap Seconds Command \endlink failure
+ * due to being in an incompatible mode.
+ */
#define CFE_TIME_LEAPS_CFG_EID 46
-/** \brief 'STCF Adjust commands invalid without CFE_PLATFORM_TIME_CFG_SERVER set to true'
-** \event 'STCF Adjust commands invalid without CFE_PLATFORM_TIME_CFG_SERVER set to true'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** either a \link #CFE_TIME_ADD_ADJUST_CC Add Single STCF Adjustment Command \endlink
-** OR a \link #CFE_TIME_SUB_ADJUST_CC Subtract Single STCF Adjustment command \endlink
-** and the Time Services configuration parameter #CFE_PLATFORM_TIME_CFG_SERVER has
-** not been set to true in the cfe_platform_cfg.h file.
-**/
+/**
+ * \brief TIME Add or Subtract Single STCF Adjustment Command Incompatible Mode Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_ADD_ADJUST_CC TIME Add Single STCF Adjustment Command \endlink OR
+ * \link #CFE_TIME_SUB_ADJUST_CC TIME Subtract Single STCF Adjustment Command \endlink failure
+ * due to being in an incompatible mode.
+ */
#define CFE_TIME_DELTA_CFG_EID 47
-/** \brief '1Hz Adjust commands invalid without CFE_PLATFORM_TIME_CFG_SERVER set to true'
-** \event '1Hz Adjust commands invalid without CFE_PLATFORM_TIME_CFG_SERVER set to true'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated whenever Time Services receives
-** either a \link #CFE_TIME_ADD_1HZ_ADJUSTMENT_CC Add STCF Adjustment each second Command \endlink
-** OR a \link #CFE_TIME_SUB_1HZ_ADJUSTMENT_CC Subtract STCF Adjustment each second command \endlink
-** and the Time Services configuration parameter #CFE_PLATFORM_TIME_CFG_SERVER has
-** not been set to true in the cfe_platform_cfg.h file.
-**/
+/**
+ * \brief TIME Add or Subtract STCF Adjustment Each Second Command Incompatible Mode Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * \link #CFE_TIME_ADD_1HZ_ADJUSTMENT_CC TIME Add STCF Adjustment Each Second Command \endlink OR
+ * \link #CFE_TIME_SUB_1HZ_ADJUSTMENT_CC TIME Subtract STCF Adjustment Each Second Command \endlink
+ * failure due to being in an incompatible mode.
+ */
#define CFE_TIME_1HZ_CFG_EID 48
-/** \brief 'Invalid cmd length: ID = 0x\%X, CC = \%d, Exp Len = \%d, Len = \%d'
-** \event 'Invalid cmd length: ID = 0x\%X, CC = \%d, Exp Len = \%d, Len = \%d'
-**
-** \par Type: ERROR
-**
-** \par Cause:
-**
-** This event message is generated when a message with the #CFE_TIME_CMD_MID
-** message ID has arrived but whose packet length does not match the expected
-** length for the specified command code.
-**
-** The \c ID field in the event message specifies the Message ID (in hex), the \c CC field
-** specifies the Command Code (in decimal), the \c Exp Len field specified the Expected
-** Length (in decimal ), and \c Len specifies the message Length (in decimal)
-** found in the message.
-**/
+/**
+ * \brief TIME Invalid Command Length Event ID
+ *
+ * \par Type: ERROR
+ *
+ * \par Cause:
+ *
+ * Invalid length for the command code in message ID #CFE_TIME_CMD_MID received on the TIME
+ * message pipe.
+ */
#define CFE_TIME_LEN_ERR_EID 49
+/**\}*/
#endif /* CFE_TIME_EVENTS_H */