| |
- Typically a caller declares a ptr of type #CFE_SB_Msg_t (i.e. CFE_SB_Msg_t *Ptr)
+ Typically a caller declares a ptr of type CFE_SB_Msg_t (i.e. CFE_SB_Msg_t *Ptr)
then gives the address of that pointer (&Ptr) as this parameter. After a successful
call to #CFE_SB_RcvMsg, Ptr will point to the first byte of the software bus message
header. This should be used as a read-only pointer. In systems with an MMU, writes
@@ -602,4 +601,3 @@
** The following are configuration parameters used to configure the cFE Software Bus
** either for each platform or for a mission as a whole.
**/
-
diff --git a/docs/src/main.dox b/docs/src/main.dox
index d2cdf1efc..068aac3cc 100644
--- a/docs/src/main.dox
+++ b/docs/src/main.dox
@@ -9,7 +9,7 @@
\subpage cfeversion
\subpage cfedependencies
\subpage cfeacronyms
- \subpage cfeglossary
+ \ref cfeglossary
Executive Services (ES)
@@ -54,7 +54,7 @@
- \subpage cfeevents
- \subpage cfecmdmnems
- \subpage cfetlmmnems
-
- \subpage cfeapi
+
- \ref cfeapi
**/
@@ -308,361 +308,3 @@
Coordinated Universal Time
**/
-
-/**
- \page cfeglossary Glossary of Terms
-
-
-
- | Term
- | Definition
- |
- | \anchor cfeadg_application Application (or App)
- | A set of data and functions that is treated as a single entity
- by the cFE. cFE resources are allocated on a per-Application
- basis. Applications are made up of a Main Task and zero or
- more Child Tasks.
- |
- | \anchor cfeadg_applicationid Application ID
- | A processor unique reference to an Application.
- NOTE: This is different from a CCSDS Application ID which is
- referred to as an "APID."
- |
- | \anchor cfeadg_api Application Programmer's Interface (API)
- | A set of routines, protocols, and tools for building software
- applications
- |
- | \anchor cfeadg_psp Platform Support Package (PSP)
- | A collection of user-provided facilities that interface an OS
- and the cFE with a specific hardware platform. The PSP is
- responsible for hardware initialization.
- |
- | \anchor cfeadg_childtask Child Task
- | A separate thread of execution that is spawned by an
- Application's Main Task.
- |
- | \anchor cfeadg_command Command
- | A Software Bus Message defined by the receiving Application.
- Commands can originate from other onboard Applications or
- from the ground.
- |
- | \anchor cfeadg_cfe Core Flight Executive (cFE)
- | A runtime environment and a set of services for hosting FSW
- Applications
- |
- | \anchor cfeadg_cds Critical Data Store (CDS)
- | A collection of data that is not modified by the OS or
- cFE following a Processor Reset.
- |
- | \anchor cfeadg_crc Cyclic Redundancy Check
- | A polynomial based method for checking that a data set
- has remained unchanged from one time period to another.
- |
- | \anchor cfeadg_developer Developer
- | Anyone who is coding a cFE Application.
- |
- | \anchor cfeadg_eventdata Event Data
- | Data describing an Event that is supplied to the cFE
- Event Service. The cFE includes this data in an
- \ref cfeadg_eventmessage "Event Message".
- |
- | \anchor cfeadg_eventfilter Event Filter
- | A numeric value (bit mask) used to determine how
- frequently to output an application Event Message
- defined by its \ref cfeadg_eventid "Event ID".
- |
- | \anchor cfeadg_eventformatmode Event Format Mode
- | Defines the Event Message Format downlink option: short or long.
- The short format is used when there is limited telemetry bandwidth
- and is binary. The long format is in ASCII and is used for
- logging to a Local Event Log and to an Event Message Port.
- |
- | \anchor cfeadg_eventid Event ID
- | A numeric literal used to uniquely name an Application event.
- |
- | \anchor cfeadg_eventtype Event Type
- | A numeric literal used to identify the type of an Application event.
- An event type may be #CFE_EVS_DEBUG, #CFE_EVS_INFORMATION,
- #CFE_EVS_ERROR, or #CFE_EVS_CRITICAL.
- |
- | \anchor cfeadg_eventmessage Event Message
- | A data item used to notify the user and/or an external
- \ref cfeadg_application "Application" of a significant event.
- Event Messages include a time-stamp of when the message was
- generated, a processor unique identifier, an
- \ref cfeadg_applicationid "Application ID", the
- \ref cfeadg_eventtype "Event Type" (DEBUG,INFO,ERROR or CRITICAL),
- and \ref cfeadg_eventdata "Event Data". An Event Message can
- either be real-time or playback from a Local Event Log.
- |
-**/
-
-/**
- \page cfeapi cFE Application Programmer's Interface (API) Reference
- Executive Services API
-
- - \ref CFEAPIESEntryExit
-
- - #CFE_ES_Main - \copybrief CFE_ES_Main
-
- #CFE_ES_ResetCFE - \copybrief CFE_ES_ResetCFE
-
- - \ref CFEAPIESAppControl
-
- - #CFE_ES_RestartApp - \copybrief CFE_ES_RestartApp
-
- #CFE_ES_ReloadApp - \copybrief CFE_ES_ReloadApp
-
- #CFE_ES_DeleteApp - \copybrief CFE_ES_DeleteApp
-
- - \ref CFEAPIESAppBehavior
-
- - #CFE_ES_RegisterApp - \copybrief CFE_ES_RegisterApp
-
- #CFE_ES_RunLoop - \copybrief CFE_ES_RunLoop
-
- #CFE_ES_WaitForStartupSync - \copybrief CFE_ES_WaitForStartupSync
-
- #CFE_ES_WaitForSystemState - \copybrief CFE_ES_WaitForSystemState
-
- #CFE_ES_IncrementTaskCounter - \copybrief CFE_ES_IncrementTaskCounter
-
- #CFE_ES_ExitApp - \copybrief CFE_ES_ExitApp
-
- - \ref CFEAPIESInfo
-
- - #CFE_ES_GetResetType - \copybrief CFE_ES_GetResetType
-
- #CFE_ES_GetAppID - \copybrief CFE_ES_GetAppID
-
- #CFE_ES_GetAppIDByName - \copybrief CFE_ES_GetAppIDByName
-
- #CFE_ES_GetAppName - \copybrief CFE_ES_GetAppName
-
- #CFE_ES_GetAppInfo - \copybrief CFE_ES_GetAppInfo
-
- #CFE_ES_GetTaskInfo - \copybrief CFE_ES_GetTaskInfo
-
- - \ref CFEAPIESChildTask
-
- - #CFE_ES_RegisterChildTask - \copybrief CFE_ES_RegisterChildTask
-
- #CFE_ES_CreateChildTask - \copybrief CFE_ES_CreateChildTask
-
- #CFE_ES_DeleteChildTask - \copybrief CFE_ES_DeleteChildTask
-
- #CFE_ES_ExitChildTask - \copybrief CFE_ES_ExitChildTask
-
- - \ref CFEAPIESCritData
-
- - #CFE_ES_RegisterCDS - \copybrief CFE_ES_RegisterCDS
-
- #CFE_ES_CopyToCDS - \copybrief CFE_ES_CopyToCDS
-
- #CFE_ES_RestoreFromCDS - \copybrief CFE_ES_RestoreFromCDS
-
- - \ref CFEAPIESMemManage
-
- - #CFE_ES_PoolCreate - \copybrief CFE_ES_PoolCreate
-
- #CFE_ES_PoolCreateEx - \copybrief CFE_ES_PoolCreateEx
-
- #CFE_ES_PoolCreateNoSem - \copybrief CFE_ES_PoolCreateNoSem
-
- #CFE_ES_GetPoolBuf - \copybrief CFE_ES_GetPoolBuf
-
- #CFE_ES_PutPoolBuf - \copybrief CFE_ES_PutPoolBuf
-
- #CFE_ES_GetMemPoolStats - \copybrief CFE_ES_GetMemPoolStats
-
- #CFE_ES_GetPoolBufInfo - \copybrief CFE_ES_GetPoolBufInfo
-
- - \ref CFEAPIESPerfMon
-
- - #CFE_ES_PerfLogEntry - \copybrief CFE_ES_PerfLogEntry
-
- #CFE_ES_PerfLogExit - \copybrief CFE_ES_PerfLogExit
-
- #CFE_ES_PerfLogAdd - \copybrief CFE_ES_PerfLogAdd
-
- - \ref CFEAPIESGenCount
-
- - #CFE_ES_RegisterGenCounter - \copybrief CFE_ES_RegisterGenCounter
-
- #CFE_ES_DeleteGenCounter - \copybrief CFE_ES_DeleteGenCounter
-
- #CFE_ES_IncrementGenCounter - \copybrief CFE_ES_IncrementGenCounter
-
- #CFE_ES_SetGenCount - \copybrief CFE_ES_SetGenCount
-
- #CFE_ES_GetGenCount - \copybrief CFE_ES_GetGenCount
-
- #CFE_ES_GetGenCounterIDByName - \copybrief CFE_ES_GetGenCounterIDByName
-
- - \ref CFEAPIESMisc
-
- - #CFE_ES_CalculateCRC - \copybrief CFE_ES_CalculateCRC
-
- #CFE_ES_WriteToSysLog - \copybrief CFE_ES_WriteToSysLog
-
- #CFE_ES_ProcessAsyncEvent - \copybrief CFE_ES_ProcessAsyncEvent
-
-
-
- Events Services API
-
- - \ref CFEAPIEVSReg
-
- - #CFE_EVS_Register - \copybrief CFE_EVS_Register
-
- #CFE_EVS_Unregister - \copybrief CFE_EVS_Unregister
-
- - \ref CFEAPIEVSSend
-
- - #CFE_EVS_SendEvent - \copybrief CFE_EVS_SendEvent
-
- #CFE_EVS_SendEventWithAppID - \copybrief CFE_EVS_SendEventWithAppID
-
- #CFE_EVS_SendTimedEvent - \copybrief CFE_EVS_SendTimedEvent
-
- - \ref CFEAPIEVSResetFilter
-
- - #CFE_EVS_ResetFilter - \copybrief CFE_EVS_ResetFilter
-
- #CFE_EVS_ResetAllFilters - \copybrief CFE_EVS_ResetAllFilters
-
-
-
- File Services API
-
- - \ref CFEAPIFSHeader
-
- - #CFE_FS_ReadHeader - \copybrief CFE_FS_ReadHeader
-
- #CFE_FS_InitHeader - \copybrief CFE_FS_InitHeader
-
- #CFE_FS_WriteHeader - \copybrief CFE_FS_WriteHeader
-
- #CFE_FS_SetTimestamp - \copybrief CFE_FS_SetTimestamp
-
- - \ref CFEAPIFSCompress
-
- - #CFE_FS_IsGzFile - \copybrief CFE_FS_IsGzFile
-
- #CFE_FS_Decompress - \copybrief CFE_FS_Decompress
-
- #CFE_FS_GetUncompressedFile - \copybrief CFE_FS_GetUncompressedFile
-
- - \ref CFEAPIFSUtil
-
- - #CFE_FS_ExtractFilenameFromPath - \copybrief CFE_FS_ExtractFilenameFromPath
-
-
-
- Software Bus API
-
- - \ref CFEAPISBPipe
-
- - #CFE_SB_CreatePipe - \copybrief CFE_SB_CreatePipe
-
- #CFE_SB_DeletePipe - \copybrief CFE_SB_DeletePipe
-
- #CFE_SB_SetPipeOpts - \copybrief CFE_SB_SetPipeOpts
-
- #CFE_SB_GetPipeOpts - \copybrief CFE_SB_GetPipeOpts
-
- #CFE_SB_GetPipeName - \copybrief CFE_SB_GetPipeName
-
- #CFE_SB_GetPipeIdByName - \copybrief CFE_SB_GetPipeIdByName
-
- - \ref CFEAPISBSubscription
-
- - #CFE_SB_Subscribe - \copybrief CFE_SB_Subscribe
-
- #CFE_SB_SubscribeEx - \copybrief CFE_SB_SubscribeEx
-
- #CFE_SB_SubscribeLocal - \copybrief CFE_SB_SubscribeLocal
-
- #CFE_SB_Unsubscribe - \copybrief CFE_SB_Unsubscribe
-
- #CFE_SB_UnsubscribeLocal - \copybrief CFE_SB_UnsubscribeLocal
-
- - \ref CFEAPISBMessage
-
- - #CFE_SB_SendMsg - \copybrief CFE_SB_SendMsg
-
- #CFE_SB_PassMsg - \copybrief CFE_SB_PassMsg
-
- #CFE_SB_RcvMsg - \copybrief CFE_SB_RcvMsg
-
- - \ref CFEAPISBZeroCopy
-
- - #CFE_SB_ZeroCopyGetPtr - \copybrief CFE_SB_ZeroCopyGetPtr
-
- #CFE_SB_ZeroCopyReleasePtr - \copybrief CFE_SB_ZeroCopyReleasePtr
-
- #CFE_SB_ZeroCopySend - \copybrief CFE_SB_ZeroCopySend
-
- #CFE_SB_ZeroCopyPass - \copybrief CFE_SB_ZeroCopyPass
-
- - \ref CFEAPISBSetMessage
-
- - #CFE_SB_InitMsg - \copybrief CFE_SB_InitMsg
-
- #CFE_SB_SetMsgId - \copybrief CFE_SB_SetMsgId
-
- #CFE_SB_SetUserDataLength - \copybrief CFE_SB_SetUserDataLength
-
- #CFE_SB_SetTotalMsgLength - \copybrief CFE_SB_SetTotalMsgLength
-
- #CFE_SB_SetMsgTime - \copybrief CFE_SB_SetMsgTime
-
- #CFE_SB_TimeStampMsg - \copybrief CFE_SB_TimeStampMsg
-
- #CFE_SB_SetCmdCode - \copybrief CFE_SB_SetCmdCode
-
- #CFE_SB_MessageStringSet - \copybrief CFE_SB_MessageStringSet
-
- - \ref CFEAPIGetMessage
-
- - #CFE_SB_GetUserData - \copybrief CFE_SB_GetUserData
-
- #CFE_SB_GetMsgId - \copybrief CFE_SB_GetMsgId
-
- #CFE_SB_GetUserDataLength - \copybrief CFE_SB_GetUserDataLength
-
- #CFE_SB_GetTotalMsgLength - \copybrief CFE_SB_GetTotalMsgLength
-
- #CFE_SB_GetMsgTime - \copybrief CFE_SB_GetMsgTime
-
- #CFE_SB_GetCmdCode - \copybrief CFE_SB_GetCmdCode
-
- #CFE_SB_GetLastSenderId - \copybrief CFE_SB_GetLastSenderId
-
- #CFE_SB_MessageStringGet - \copybrief CFE_SB_MessageStringGet
-
- - \ref CFEAPISBChecksum
-
- - #CFE_SB_GenerateChecksum - \copybrief CFE_SB_GenerateChecksum
-
- #CFE_SB_GetChecksum - \copybrief CFE_SB_GetChecksum
-
- #CFE_SB_ValidateChecksum - \copybrief CFE_SB_ValidateChecksum
-
- - \ref CFEAPISBMessageID
-
- - #CFE_SB_MsgId_Equal - \copybrief CFE_SB_MsgId_Equal
-
- #CFE_SB_MsgIdToValue - \copybrief CFE_SB_MsgIdToValue
-
- #CFE_SB_ValueToMsgId - \copybrief CFE_SB_ValueToMsgId
-
-
-
- Table Services API
-
- - \ref CFEAPITBLRegistration
-
- - #CFE_TBL_Register - \copybrief CFE_TBL_Register
-
- #CFE_TBL_Share - \copybrief CFE_TBL_Share
-
- #CFE_TBL_Unregister - \copybrief CFE_TBL_Unregister
-
- - \ref CFEAPITBLManage
-
- - #CFE_TBL_Load - \copybrief CFE_TBL_Load
-
- #CFE_TBL_Update - \copybrief CFE_TBL_Update
-
- #CFE_TBL_Validate - \copybrief CFE_TBL_Validate
-
- #CFE_TBL_Manage - \copybrief CFE_TBL_Manage
-
- #CFE_TBL_DumpToBuffer - \copybrief CFE_TBL_DumpToBuffer
-
- #CFE_TBL_Modified - \copybrief CFE_TBL_Modified
-
- - \ref CFEAPITBLAccess
-
- - #CFE_TBL_GetAddress - \copybrief CFE_TBL_GetAddress
-
- #CFE_TBL_GetAddresses - \copybrief CFE_TBL_GetAddresses
-
- #CFE_TBL_ReleaseAddress - \copybrief CFE_TBL_ReleaseAddress
-
- #CFE_TBL_ReleaseAddresses - \copybrief CFE_TBL_ReleaseAddresses
-
- - \ref CFEAPITBLInfo
-
- - #CFE_TBL_GetStatus - \copybrief CFE_TBL_GetStatus
-
- #CFE_TBL_GetInfo - \copybrief CFE_TBL_GetInfo
-
- #CFE_TBL_NotifyByMessage - \copybrief CFE_TBL_NotifyByMessage
-
-
-
- Time Services API
-
- - \ref CFEAPITIMEGetCurrent
-
- - #CFE_TIME_GetTime - \copybrief CFE_TIME_GetTime
-
- #CFE_TIME_GetTAI - \copybrief CFE_TIME_GetTAI
-
- #CFE_TIME_GetUTC - \copybrief CFE_TIME_GetUTC
-
- #CFE_TIME_GetMET - \copybrief CFE_TIME_GetMET
-
- #CFE_TIME_GetMETseconds - \copybrief CFE_TIME_GetMETseconds
-
- #CFE_TIME_GetMETsubsecs - \copybrief CFE_TIME_GetMETsubsecs
-
- - \ref CFEAPITIMEGetInfo
-
- - #CFE_TIME_GetSTCF - \copybrief CFE_TIME_GetSTCF
-
- #CFE_TIME_GetLeapSeconds - \copybrief CFE_TIME_GetLeapSeconds
-
- #CFE_TIME_GetClockState - \copybrief CFE_TIME_GetClockState
-
- #CFE_TIME_GetClockInfo - \copybrief CFE_TIME_GetClockInfo
-
- - \ref CFEAPITIMEArithmetic
-
- - #CFE_TIME_Add - \copybrief CFE_TIME_Add
-
- #CFE_TIME_Subtract - \copybrief CFE_TIME_Subtract
-
- #CFE_TIME_Compare - \copybrief CFE_TIME_Compare
-
- - \ref CFEAPITIMEConvert
-
- - #CFE_TIME_MET2SCTime - \copybrief CFE_TIME_MET2SCTime
-
- #CFE_TIME_Sub2MicroSecs - \copybrief CFE_TIME_Sub2MicroSecs
-
- #CFE_TIME_Micro2SubSecs - \copybrief CFE_TIME_Micro2SubSecs
-
- #CFE_TIME_CFE2FSSeconds - \copybrief CFE_TIME_CFE2FSSeconds
-
- #CFE_TIME_FS2CFESeconds - \copybrief CFE_TIME_FS2CFESeconds
-
- - \ref CFEAPITIMEExternSource
-
- - #CFE_TIME_ExternalTone - \copybrief CFE_TIME_ExternalTone
-
- #CFE_TIME_ExternalMET - \copybrief CFE_TIME_ExternalMET
-
- #CFE_TIME_ExternalGPS - \copybrief CFE_TIME_ExternalGPS
-
- #CFE_TIME_ExternalTime - \copybrief CFE_TIME_ExternalTime
-
- #CFE_TIME_RegisterSynchCallback - \copybrief CFE_TIME_RegisterSynchCallback
-
- #CFE_TIME_UnregisterSynchCallback - \copybrief CFE_TIME_UnregisterSynchCallback
-
- - \ref CFEAPITIMEMisc
-
- - #CFE_TIME_Print - \copybrief CFE_TIME_Print
-
- #CFE_TIME_Local1HzISR - \copybrief CFE_TIME_Local1HzISR
-
-
-**/
-
diff --git a/fsw/cfe-core/src/es/cfe_es_cds.h b/fsw/cfe-core/src/es/cfe_es_cds.h
index 8d910e01e..ee32f7544 100644
--- a/fsw/cfe-core/src/es/cfe_es_cds.h
+++ b/fsw/cfe-core/src/es/cfe_es_cds.h
@@ -58,6 +58,8 @@
#define CFE_ES_CDS_MUT_REG_VALUE 0 /**< \brief Initial Value of CDS Registry Access Mutex */
#define CFE_ES_CDS_NOT_FOUND (uint32)(0xffffffff)
+/** \} */
+
/*
** Type Definitions
*/
@@ -121,9 +123,8 @@ int32 CFE_ES_UpdateCDSRegistry(void);
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] AppIdPtr Pointer to value that will hold AppID on return.
+** \param[in, out] AppIdPtr Pointer to value that will hold AppID on return. *AppIdPtr is the AppID as obtained from #CFE_ES_GetAppID.
**
-** \param[out] *AppIdPtr The AppID as obtained from #CFE_ES_GetAppID
**
** \retval #CFE_SUCCESS \copydoc CFE_SUCCESS
** \retval #CFE_ES_ERR_APPID \copydoc CFE_ES_ERR_APPID
@@ -144,17 +145,15 @@ int32 CFE_ES_CDS_ValidateAppID(uint32 *AppIdPtr);
** \par Assumptions, External Events, and Notes:
** Note: AppName portion will be truncated to OS_MAX_API_NAME.
**
-** \param[in] FullCDSName pointer to character buffer of #CFE_ES_CDS_MAX_FULL_NAME_LEN size
-** that will be filled with the processor specific CDS Name.
+** \param[in, out] FullCDSName pointer to character buffer of #CFE_ES_CDS_MAX_FULL_NAME_LEN size
+** that will be filled with the processor specific CDS Name. *FullCDSName is the processor specific CDS Name of the form "AppName.CDSName".
**
** \param[in] CDSName pointer to character string containing the Application's local name for
** the CDS.
**
** \param[in] ThisAppId the Application ID of the Application making the call.
**
-** \param[out] *FullCDSName processor specific CDS Name of the form "AppName.CDSName".
**
-** \retval None
******************************************************************************/
void CFE_ES_FormCDSName(char *FullCDSName, const char *CDSName, uint32 ThisAppId);
@@ -173,7 +172,7 @@ void CFE_ES_FormCDSName(char *FullCDSName, const char *CDSName, uint32 ThisAppId
** CDS Name (of the format "AppName.CDSName").
**
** \retval #CFE_ES_CDS_NOT_FOUND or the Index into Registry for Table with specified name
-**
+**
******************************************************************************/
int32 CFE_ES_FindCDSInRegistry(const char *CDSName);
diff --git a/fsw/cfe-core/src/inc/cfe_es.h b/fsw/cfe-core/src/inc/cfe_es.h
index b52d0cbe9..6df04cfad 100644
--- a/fsw/cfe-core/src/inc/cfe_es.h
+++ b/fsw/cfe-core/src/inc/cfe_es.h
@@ -490,9 +490,11 @@ int32 CFE_ES_DeleteApp(uint32 AppID);
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] ExitStatus .
-**
-** \return Execution status, see \ref CFEReturnCodes
+** \param[in] ExitStatus Acceptable values are: \arg #CFE_ES_RunStatus_APP_EXIT - \copybrief CFE_ES_RunStatus_APP_EXIT
+ \arg #CFE_ES_RunStatus_APP_ERROR - \copybrief CFE_ES_RunStatus_APP_ERROR
+ \arg #CFE_ES_RunStatus_CORE_APP_INIT_ERROR - \copybrief CFE_ES_RunStatus_CORE_APP_INIT_ERROR
+ \arg #CFE_ES_RunStatus_CORE_APP_RUNTIME_ERROR - \copybrief CFE_ES_RunStatus_CORE_APP_RUNTIME_ERROR
+**
**
** \sa #CFE_ES_RunLoop, #CFE_ES_RegisterApp
**
@@ -645,12 +647,11 @@ void CFE_ES_IncrementTaskCounter(void);
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] ResetSubtypePtr Pointer to \c uint32 type variable in which the Reset Sub-Type will be stored.
-** The caller can set this pointer to NULL if the Sub-Type is of no interest.
-**
-** \param[out] *ResetSubtypePtr If the provided pointer was not \c NULL, the Reset Sub-Type is stored at the given address.
+** \param[in, out] ResetSubtypePtr Pointer to \c uint32 type variable in which the Reset Sub-Type will be stored.
+** The caller can set this pointer to NULL if the Sub-Type is of no interest. \n *ResetSubtypePtr If the provided pointer was not \c NULL, the Reset Sub-Type is stored at the given address.
** For a list of possible Sub-Type values, see \link #CFE_PSP_RST_SUBTYPE_POWER_CYCLE "Reset Sub-Types" \endlink.
**
+**
** \return Processor reset type
** \retval #CFE_PSP_RST_TYPE_POWERON \copybrief CFE_PSP_RST_TYPE_POWERON
** \retval #CFE_PSP_RST_TYPE_PROCESSOR \copybrief CFE_PSP_RST_TYPE_PROCESSOR
@@ -670,9 +671,8 @@ int32 CFE_ES_GetResetType(uint32 *ResetSubtypePtr);
** \par Assumptions, External Events, and Notes:
** NOTE: \b All tasks associated with the Application would return the same Application ID.
**
-** \param[in] AppIdPtr Pointer to variable that is to receive the Application's ID.
+** \param[in] AppIdPtr Pointer to variable that is to receive the Application's ID. *AppIdPtr is the application ID of the calling Application.
**
-** \param[out] *AppIdPtr Application ID of the calling Application.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -695,11 +695,10 @@ int32 CFE_ES_GetAppID(uint32 *AppIdPtr);
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] AppIdPtr Pointer to variable that is to receive the Application's ID.
+** \param[in] AppIdPtr Pointer to variable that is to receive the Application's ID. *AppIdPtr is the application ID of the calling Application.
**
** \param[in] AppName Pointer to null terminated character string containing an Application name.
**
-** \param[out] *AppIdPtr Application ID of the calling Application.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -723,8 +722,9 @@ int32 CFE_ES_GetAppIDByName(uint32 *AppIdPtr, const char *AppName);
** In the case of a failure (#CFE_ES_ERR_APPID), an empty string is returned. #CFE_ES_ERR_APPID
** will be returned if the specified Application ID (AppId) is invalid or not in use.
**
-** \param[in] AppName Pointer to a character array of at least \c BufferLength in size that will
-** be filled with the appropriate Application name.
+** \param[in, out] AppName Pointer to a character array of at least \c BufferLength in size that will
+** be filled with the appropriate Application name. *AppName is the null terminated Application name of the Application associated with the
+** specified Application ID
**
** \param[in] AppId Application ID of Application whose name is being requested.
**
@@ -732,8 +732,6 @@ int32 CFE_ES_GetAppIDByName(uint32 *AppIdPtr, const char *AppName);
** into the \c AppName buffer. This routine will truncate the name to this length,
** if necessary.
**
-** \param[out] *AppName Null terminated Application name of the Application associated with the
-** specified Application ID.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -756,13 +754,12 @@ int32 CFE_ES_GetAppName(char *AppName, uint32 AppId, uint32 BufferLength);
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] AppInfo Pointer to a \c CFE_ES_AppInfo_t structure that holds the specific
-** Application information.
+** \param[in, out] AppInfo Pointer to a \c CFE_ES_AppInfo_t structure that holds the specific
+** Application information. *AppInfo is the filled out \c CFE_ES_AppInfo_t structure containing the
+** App Name, and application memory addresses among other fields.
**
** \param[in] AppId Application ID of Application whose name is being requested.
**
-** \param[out] *AppInfo Filled out \c CFE_ES_AppInfo_t structure containing the
-** App Name, and application memory addresses among other fields.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -786,13 +783,12 @@ int32 CFE_ES_GetAppInfo(CFE_ES_AppInfo_t *AppInfo, uint32 AppId);
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] TaskInfo Pointer to a \c CFE_ES_TaskInfo_t structure that holds the specific
-** task information.
+** \param[in, out] TaskInfo Pointer to a \c CFE_ES_TaskInfo_t structure that holds the specific
+** task information. *TaskInfo is the filled out \c CFE_ES_TaskInfo_t structure containing the
+** Task Name, Parent App Name, Parent App ID among other fields.
**
** \param[in] TaskId Application ID of Application whose name is being requested.
**
-** \param[out] *TaskInfo Filled out \c CFE_ES_TaskInfo_t structure containing the
-** Task Name, Parent App Name, Parent App ID among other fields.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -839,7 +835,7 @@ int32 CFE_ES_RegisterChildTask(void);
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] TaskIdPtr A pointer to a variable that will be filled in with the new task's ID.
+** \param[in, out] TaskIdPtr A pointer to a variable that will be filled in with the new task's ID. *TaskIdPtr is the Task ID of the newly created child task.
**
** \param[in] TaskName A pointer to a string containing the desired name of the new task.
** This can be up to #OS_MAX_API_NAME characters, including the trailing null.
@@ -859,8 +855,6 @@ int32 CFE_ES_RegisterChildTask(void);
**
** \param[in] Flags Reserved for future expansion.
**
-** \param[out] *TaskIdPtr The Task ID of the newly created child task.
-**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
** \retval #CFE_ES_ERR_CHILD_TASK_CREATE \copybrief CFE_ES_ERR_CHILD_TASK_CREATE
@@ -909,7 +903,7 @@ int32 CFE_ES_DeleteChildTask(uint32 TaskId);
** \par Assumptions, External Events, and Notes:
** This function cannot be called from an Application's Main Task.
**
-** \return This function does not return a value, but if it does return
+** \note This function does not return a value, but if it does return
** at all, it is assumed that the Task was either unregistered or
** this function was called from a cFE Application's main task.
**
@@ -1011,15 +1005,14 @@ void CFE_ES_ProcessAsyncEvent(void);
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] HandlePtr Pointer Application's variable that will contain the CDS Memory Block Handle.
+** \param[in, out] HandlePtr Pointer Application's variable that will contain the CDS Memory Block Handle. *HandlePtr is the handle of the CDS block that can be used in
+** #CFE_ES_CopyToCDS and #CFE_ES_RestoreFromCDS.
**
** \param[in] BlockSize The number of bytes needed in the CDS.
**
** \param[in] Name A pointer to a character string containing an application
** unique name of #CFE_MISSION_ES_CDS_MAX_NAME_LENGTH characters or less.
**
-** \param[out] *HandlePtr The handle of the CDS block that can be used in
-** #CFE_ES_CopyToCDS and #CFE_ES_RestoreFromCDS.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS The memory block was successfully created in the CDS.
@@ -1077,9 +1070,7 @@ int32 CFE_ES_CopyToCDS(CFE_ES_CDSHandle_t Handle, void *DataToCopy);
**
** \param[in] Handle The handle of the CDS block that was previously obtained from #CFE_ES_RegisterCDS.
**
-** \param[in] RestoreToMemory A Pointer to the block of memory that is to be restored with the contents of the CDS.
-**
-** \param[out] *RestoreToMemory The contents of the specified CDS.
+** \param[in, out] RestoreToMemory A Pointer to the block of memory that is to be restored with the contents of the CDS. *RestoreToMemory is the contents of the specified CDS.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -1109,15 +1100,13 @@ int32 CFE_ES_RestoreFromCDS(void *RestoreToMemory, CFE_ES_CDSHandle_t Handle);
** -# The start address of the pool must be 32-bit aligned
** -# 168 bytes are used for internal bookkeeping, therefore, they will not be available for allocation.
**
-** \param[in] HandlePtr A pointer to the variable the caller wishes to have the memory pool handle kept in.
+** \param[in, out] HandlePtr A pointer to the variable the caller wishes to have the memory pool handle kept in. *HandlePtr is the memory pool handle.
**
** \param[in] MemPtr A Pointer to the pool of memory created by the calling application. This address must
** be on a 32-bit boundary.
**
** \param[in] Size The size of the pool of memory. Note that this must be an integral number of 32 bit words.
**
-** \param[out] *HandlePtr The memory pool handle.
-**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
** \retval #CFE_ES_BAD_ARGUMENT \copybrief CFE_ES_BAD_ARGUMENT
@@ -1140,15 +1129,13 @@ int32 CFE_ES_PoolCreateNoSem(CFE_ES_MemHandle_t *HandlePtr, uint8 *MemPtr, uint3
** -# The start address of the pool must be 32-bit aligned
** -# 168 bytes are used for internal bookkeeping, therefore, they will not be available for allocation.
**
-** \param[in] HandlePtr A pointer to the variable the caller wishes to have the memory pool handle kept in.
+** \param[in, out] HandlePtr A pointer to the variable the caller wishes to have the memory pool handle kept in. *HandlePtr is the memory pool handle.
**
** \param[in] MemPtr A Pointer to the pool of memory created by the calling application. This address must
** be on a 32-bit boundary.
**
** \param[in] Size The size of the pool of memory. Note that this must be an integral number of 32 bit words.
**
-** \param[out] *HandlePtr The memory pool handle.
-**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
** \retval #CFE_ES_BAD_ARGUMENT \copybrief CFE_ES_BAD_ARGUMENT
@@ -1170,7 +1157,7 @@ int32 CFE_ES_PoolCreate(CFE_ES_MemHandle_t *HandlePtr, uint8 *MemPtr, uint32 Siz
** -# The start address of the pool must be 32-bit aligned
** -# 168 bytes are used for internal bookkeeping, therefore, they will not be available for allocation.
**
-** \param[in] HandlePtr A pointer to the variable the caller wishes to have the memory pool handle kept in.
+** \param[in, out] HandlePtr A pointer to the variable the caller wishes to have the memory pool handle kept in. *HandlePtr is the memory pool handle.
**
** \param[in] MemPtr A Pointer to the pool of memory created by the calling application. This address must
** be on a 32-bit boundary.
@@ -1187,8 +1174,6 @@ int32 CFE_ES_PoolCreate(CFE_ES_MemHandle_t *HandlePtr, uint8 *MemPtr, uint32 Siz
** \param[in] UseMutex Flag indicating whether the new memory pool will be processing with mutex handling or not.
** Valid parameter values are #CFE_ES_USE_MUTEX and #CFE_ES_NO_MUTEX
**
-** \param[out] *HandlePtr The memory pool handle.
-**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
** \retval #CFE_ES_BAD_ARGUMENT \copybrief CFE_ES_BAD_ARGUMENT
@@ -1208,14 +1193,12 @@ int32 CFE_ES_PoolCreateEx(CFE_ES_MemHandle_t *HandlePtr, uint8 *MemPtr, uint32 S
** \par Assumptions, External Events, and Notes:
** -# The size allocated from the memory pool is, at a minimum, 12 bytes more than requested.
**
-** \param[in] BufPtr A pointer to the Application's pointer in which will be stored the address of the allocated memory buffer.
+** \param[in, out] BufPtr A pointer to the Application's pointer in which will be stored the address of the allocated memory buffer. *BufPtr is the address of the requested buffer.
**
** \param[in] HandlePtr The handle to the memory pool as returned by #CFE_ES_PoolCreate or #CFE_ES_PoolCreateNoSem.
**
** \param[in] Size The size of the buffer requested. NOTE: The size allocated may be larger.
**
-** \param[out] *BufPtr The address of the requested buffer.
-**
** \return Bytes Allocated, or error code \ref CFEReturnCodes
** \retval #CFE_ES_ERR_MEM_HANDLE \copybrief CFE_ES_ERR_MEM_HANDLE
** \retval #CFE_ES_ERR_MEM_BLOCK_SIZE \copybrief CFE_ES_ERR_MEM_BLOCK_SIZE
@@ -1283,12 +1266,11 @@ int32 CFE_ES_PutPoolBuf(CFE_ES_MemHandle_t HandlePtr, uint32 *BufPtr);
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] BufPtr Pointer to #CFE_ES_MemPoolStats_t data structure to be
-** filled with memory statistics.
+** \param[in, out] BufPtr Pointer to #CFE_ES_MemPoolStats_t data structure to be
+** filled with memory statistics. *BufPtr is the Memory Pool Statistics stored in given data structure.
**
** \param[in] Handle The handle to the memory pool whose statistics are desired.
**
-** \param[out] *BufPtr Memory Pool Statistics stored in given data structure.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
diff --git a/fsw/cfe-core/src/inc/cfe_fs.h b/fsw/cfe-core/src/inc/cfe_fs.h
index 5179bd592..5d81bf660 100644
--- a/fsw/cfe-core/src/inc/cfe_fs.h
+++ b/fsw/cfe-core/src/inc/cfe_fs.h
@@ -91,10 +91,8 @@
** \param[in] FileDes File Descriptor obtained from a previous call to #OS_open
** that is associated with the file whose header is to be read.
**
-** \param[in] Hdr Pointer to a variable of type #CFE_FS_Header_t that will be
-** filled with the contents of the Standard cFE File Header.
-**
-** \param[out] *Hdr Contents of the Standard cFE File Header for the specified file.
+** \param[in, out] Hdr Pointer to a variable of type #CFE_FS_Header_t that will be
+** filled with the contents of the Standard cFE File Header. *Hdr is the contents of the Standard cFE File Header for the specified file.
**
** \return Execution status, see \ref CFEReturnCodes
**
@@ -151,10 +149,8 @@ void CFE_FS_InitHeader(CFE_FS_Header_t *Hdr, const char *Description, uint32 Sub
** \param[in] FileDes File Descriptor obtained from a previous call to #OS_open
** that is associated with the file whose header is to be read.
**
-** \param[in] Hdr Pointer to a variable of type #CFE_FS_Header_t that will be
-** filled with the contents of the Standard cFE File Header.
-**
-** \param[out] *Hdr Contents of the Standard cFE File Header for the specified file.
+** \param[in, out] Hdr Pointer to a variable of type #CFE_FS_Header_t that will be
+** filled with the contents of the Standard cFE File Header. *Hdr is the contents of the Standard cFE File Header for the specified file.
**
** \return Execution status, see \ref CFEReturnCodes
**
diff --git a/fsw/cfe-core/src/inc/cfe_sb.h b/fsw/cfe-core/src/inc/cfe_sb.h
index 0b515e83b..7f92c3794 100644
--- a/fsw/cfe-core/src/inc/cfe_sb.h
+++ b/fsw/cfe-core/src/inc/cfe_sb.h
@@ -153,7 +153,7 @@ typedef union {
uint32 Dword; /**< \brief Forces minimum of 32-bit alignment for this object */
uint8 Byte[sizeof(CCSDS_PriHdr_t)]; /**< \brief Allows byte-level access */
}CFE_SB_Msg_t;
-
+
/** \brief Generic Software Bus Command Header Type Definition */
typedef union {
CCSDS_CommandPacket_t Cmd;
@@ -170,15 +170,15 @@ typedef union {
#define CFE_SB_TLM_HDR_SIZE (sizeof(CFE_SB_TlmHdr_t))/**< \brief Size of #CFE_SB_TlmHdr_t in bytes */
/** \brief CFE_SB_TimeOut_t to primitive type definition
-**
+**
** Internally used by SB in the #CFE_SB_RcvMsg API. Translated from the
-** input parmater named TimeOut which specifies the maximum time in
+** input parmater named TimeOut which specifies the maximum time in
** milliseconds that the caller wants to wait for a message.
*/
typedef uint32 CFE_SB_TimeOut_t;
-/** \brief CFE_SB_PipeId_t to primitive type definition
-**
+/** \brief CFE_SB_PipeId_t to primitive type definition
+**
** Software Bus pipe identifier used in many SB APIs
*/
typedef uint8 CFE_SB_PipeId_t;
@@ -189,8 +189,8 @@ typedef CFE_SB_Msg_t *CFE_SB_MsgPtr_t;
/** \brief CFE_SB_MsgPayloadPtr_t defined as an opaque pointer to a message Payload portion */
typedef uint8 *CFE_SB_MsgPayloadPtr_t;
-/** \brief CFE_SB_ZeroCopyHandle_t to primitive type definition
-**
+/** \brief CFE_SB_ZeroCopyHandle_t to primitive type definition
+**
** Software Zero Copy handle used in many SB APIs
*/
typedef cpuaddr CFE_SB_ZeroCopyHandle_t;
@@ -199,7 +199,7 @@ typedef cpuaddr CFE_SB_ZeroCopyHandle_t;
**
** Currently an unused parameter in #CFE_SB_SubscribeEx
** Intended to be used for interprocessor communication only
-**/
+**/
typedef struct {
uint8 Priority;/**< \brief Specify high(1) or low(0) message priority for off-board routing, currently unused */
uint8 Reliability;/**< \brief Specify high(1) or low(0) message transfer reliability for off-board routing, currently unused */
@@ -210,7 +210,7 @@ extern CFE_SB_Qos_t CFE_SB_Default_Qos;/**< \brief Defines a default priority a
/** \brief Message Sender Identification Type Definition
**
-** Parameter used in #CFE_SB_GetLastSenderId API which allows the receiver of a message
+** Parameter used in #CFE_SB_GetLastSenderId API which allows the receiver of a message
** to validate the sender of the message.
**/
typedef struct {
@@ -225,32 +225,30 @@ typedef struct {
*/
/*****************************************************************************/
-/**
+/**
** \brief Creates a new software bus pipe.
**
** \par Description
-** This routine creates and initializes an input pipe that the calling
-** application can use to receive software bus messages. By default, no
-** messages are routed to the new pipe. So, the application must use
-** #CFE_SB_Subscribe to specify which messages it wants to receive on
+** This routine creates and initializes an input pipe that the calling
+** application can use to receive software bus messages. By default, no
+** messages are routed to the new pipe. So, the application must use
+** #CFE_SB_Subscribe to specify which messages it wants to receive on
** this pipe.
**
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] PipeIdPtr A pointer to a variable of type #CFE_SB_PipeId_t,
-** which will be filled in with the pipe ID information
-** by the #CFE_SB_CreatePipe routine.
+** \param[in, out] PipeIdPtr A pointer to a variable of type #CFE_SB_PipeId_t,
+** which will be filled in with the pipe ID information
+** by the #CFE_SB_CreatePipe routine. *PipeIdPtr is the identifier for the created pipe.
**
-** \param[in] Depth The maximum number of messages that will be allowed on
-** this pipe at one time.
+** \param[in] Depth The maximum number of messages that will be allowed on
+** this pipe at one time.
**
-** \param[in] PipeName A string to be used to identify this pipe in error messages
-** and routing information telemetry. The string must be no
-** longer than #OS_MAX_API_NAME (including terminator).
-** Longer strings will be truncated.
-**
-** \param[out] *PipeIdPtr The identifier for the created pipe.
+** \param[in] PipeName A string to be used to identify this pipe in error messages
+** and routing information telemetry. The string must be no
+** longer than #OS_MAX_API_NAME (including terminator).
+** Longer strings will be truncated.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -265,13 +263,13 @@ int32 CFE_SB_CreatePipe(CFE_SB_PipeId_t *PipeIdPtr,
const char *PipeName);
/*****************************************************************************/
-/**
+/**
** \brief Delete a software bus pipe.
**
** \par Description
-** This routine deletes an input pipe and cleans up all data structures
-** associated with the pipe. All subscriptions made for this pipe by
-** calls to #CFE_SB_Subscribe will be automatically removed from the
+** This routine deletes an input pipe and cleans up all data structures
+** associated with the pipe. All subscriptions made for this pipe by
+** calls to #CFE_SB_Subscribe will be automatically removed from the
** SB routing tables. Any messages in the pipe will be discarded.
**
** Applications should not call this routine for all of their
@@ -283,7 +281,7 @@ int32 CFE_SB_CreatePipe(CFE_SB_PipeId_t *PipeIdPtr,
** None
**
** \param[in] PipeId The pipe ID (obtained previously from #CFE_SB_CreatePipe)
-** of the pipe to be deleted.
+** of the pipe to be deleted.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -380,7 +378,7 @@ int32 CFE_SB_GetPipeIdByName(CFE_SB_PipeId_t *PipeIdPtr, const char *PipeName);
*/
/*****************************************************************************/
-/**
+/**
** \brief Subscribe to a message on the software bus
**
** \par Description
@@ -396,17 +394,17 @@ int32 CFE_SB_GetPipeIdByName(CFE_SB_PipeId_t *PipeIdPtr, const char *PipeName);
** shortest possible time, the developer may consider holding off its
** subscription until other applications have subscribed to the message.
**
-** \param[in] MsgId The message ID of the message to be subscribed to.
+** \param[in] MsgId The message ID of the message to be subscribed to.
**
-** \param[in] PipeId The pipe ID of the pipe the subscribed message
-** should be sent to.
+** \param[in] PipeId The pipe ID of the pipe the subscribed message
+** should be sent to.
**
-** \param[in] Quality The requested Quality of Service (QoS) required of
+** \param[in] Quality The requested Quality of Service (QoS) required of
** the messages. Most callers will use #CFE_SB_Default_Qos
** for this parameter.
**
** \param[in] MsgLim The maximum number of messages with this Message ID to
-** allow in this pipe at the same time.
+** allow in this pipe at the same time.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -423,13 +421,13 @@ int32 CFE_SB_SubscribeEx(CFE_SB_MsgId_t MsgId,
uint16 MsgLim);
/*****************************************************************************/
-/**
+/**
** \brief Subscribe to a message on the software bus with default parameters
**
** \par Description
-** This routine adds the specified pipe to the destination list for
-** the specified message ID. This is the same as #CFE_SB_SubscribeEx
-** with the Quality field set to #CFE_SB_Default_Qos and MsgLim set
+** This routine adds the specified pipe to the destination list for
+** the specified message ID. This is the same as #CFE_SB_SubscribeEx
+** with the Quality field set to #CFE_SB_Default_Qos and MsgLim set
** to #CFE_PLATFORM_SB_DEFAULT_MSG_LIMIT (4).
**
** \par Assumptions, External Events, and Notes:
@@ -441,10 +439,10 @@ int32 CFE_SB_SubscribeEx(CFE_SB_MsgId_t MsgId,
** shortest possible time, the developer may consider holding off its
** subscription until other applications have subscribed to the message.
**
-** \param[in] MsgId The message ID of the message to be subscribed to.
+** \param[in] MsgId The message ID of the message to be subscribed to.
**
-** \param[in] PipeId The pipe ID of the pipe the subscribed message
-** should be sent to.
+** \param[in] PipeId The pipe ID of the pipe the subscribed message
+** should be sent to.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -458,27 +456,27 @@ int32 CFE_SB_SubscribeEx(CFE_SB_MsgId_t MsgId,
int32 CFE_SB_Subscribe(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId);
/*****************************************************************************/
-/**
+/**
** \brief Subscribe to a message while keeping the request local to a cpu
**
** \par Description
-** This routine adds the specified pipe to the destination list for
-** the specified message ID. This is similar to #CFE_SB_SubscribeEx
-** with the Quality field set to #CFE_SB_Default_Qos and MsgLim set
+** This routine adds the specified pipe to the destination list for
+** the specified message ID. This is similar to #CFE_SB_SubscribeEx
+** with the Quality field set to #CFE_SB_Default_Qos and MsgLim set
** to #CFE_PLATFORM_SB_DEFAULT_MSG_LIMIT, but will not report the subscription.
** Subscription Reporting is enabled for interprocessor communication
-** by way of the Software Bus Network (SBN) Application.
+** by way of the Software Bus Network (SBN) Application.
**
** \par Assumptions, External Events, and Notes:
** - This API is typically only used by Software Bus Network (SBN) Application
**
-** \param[in] MsgId The message ID of the message to be subscribed to.
+** \param[in] MsgId The message ID of the message to be subscribed to.
**
-** \param[in] PipeId The pipe ID of the pipe the subscribed message
-** should be sent to.
+** \param[in] PipeId The pipe ID of the pipe the subscribed message
+** should be sent to.
**
** \param[in] MsgLim The maximum number of messages with this Message ID to
-** allow in this pipe at the same time.
+** allow in this pipe at the same time.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -494,20 +492,20 @@ int32 CFE_SB_SubscribeLocal(CFE_SB_MsgId_t MsgId,
uint16 MsgLim);
/*****************************************************************************/
-/**
+/**
** \brief Remove a subscription to a message on the software bus
**
** \par Description
-** This routine removes the specified pipe from the destination
+** This routine removes the specified pipe from the destination
** list for the specified message ID.
**
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] MsgId The message ID of the message to be unsubscribed.
+** \param[in] MsgId The message ID of the message to be unsubscribed.
**
-** \param[in] PipeId The pipe ID of the pipe the subscribed message
-** should no longer be sent to.
+** \param[in] PipeId The pipe ID of the pipe the subscribed message
+** should no longer be sent to.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -519,20 +517,20 @@ int32 CFE_SB_SubscribeLocal(CFE_SB_MsgId_t MsgId,
int32 CFE_SB_Unsubscribe(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId);
/*****************************************************************************/
-/**
+/**
** \brief Remove a subscription to a message on the software bus on the current CPU
**
** \par Description
-** This routine removes the specified pipe from the destination
+** This routine removes the specified pipe from the destination
** list for the specified message ID on the current CPU.
**
** \par Assumptions, External Events, and Notes:
** - This API is typically only used by Software Bus Network (SBN) Application
**
-** \param[in] MsgId The message ID of the message to be unsubscribed.
+** \param[in] MsgId The message ID of the message to be unsubscribed.
**
-** \param[in] PipeId The pipe ID of the pipe the subscribed message
-** should no longer be sent to.
+** \param[in] PipeId The pipe ID of the pipe the subscribed message
+** should no longer be sent to.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -549,26 +547,26 @@ int32 CFE_SB_UnsubscribeLocal(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId);
*/
/*****************************************************************************/
-/**
+/**
** \brief Send a software bus message
**
** \par Description
-** This routine sends the specified message to all subscribers. The
-** software bus will read the message ID from the message header to
+** This routine sends the specified message to all subscribers. The
+** software bus will read the message ID from the message header to
** determine which pipes should receive the message.
**
** \par Assumptions, External Events, and Notes:
-** - This routine will not normally wait for the receiver tasks to
+** - This routine will not normally wait for the receiver tasks to
** process the message before returning control to the caller's task.
-** - However, if a higher priority task is pending and subscribed to
-** this message, that task may get to run before #CFE_SB_SendMsg
+** - However, if a higher priority task is pending and subscribed to
+** this message, that task may get to run before #CFE_SB_SendMsg
** returns control to the caller.
-** - This function tracks and increments the source sequence counter
+** - This function tracks and increments the source sequence counter
** of a telemetry message.
**
** \param[in] MsgPtr A pointer to the message to be sent. This must point
** to the first byte of the software bus message header
-** (#CFE_SB_Msg_t).
+** (#CFE_SB_Msg_t).
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -581,27 +579,27 @@ int32 CFE_SB_UnsubscribeLocal(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId);
int32 CFE_SB_SendMsg(CFE_SB_Msg_t *MsgPtr);
/*****************************************************************************/
-/**
+/**
** \brief Passes a software bus message
**
** \par Description
-** This routine sends the specified message to all subscribers. The
-** software bus will read the message ID from the message header to
+** This routine sends the specified message to all subscribers. The
+** software bus will read the message ID from the message header to
** determine which pipes should receive the message. This routine is
** intended to pass messages not generated by the sending application.
**
** \par Assumptions, External Events, and Notes:
-** - This routine will not normally wait for the receiver tasks to
+** - This routine will not normally wait for the receiver tasks to
** process the message before returning control to the caller's task.
-** - However, if a higher priority task is pending and subscribed to
-** this message, that task may get to run before #CFE_SB_PassMsg
+** - However, if a higher priority task is pending and subscribed to
+** this message, that task may get to run before #CFE_SB_PassMsg
** returns control to the caller.
** - Unlike #CFE_SB_SendMsg this routine will preserve the source
** sequence counter in a telemetry message.
**
** \param[in] MsgPtr A pointer to the message to be sent. This must point
** to the first byte of the software bus message header
-** (#CFE_SB_Msg_t).
+** (#CFE_SB_Msg_t).
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -614,40 +612,38 @@ int32 CFE_SB_SendMsg(CFE_SB_Msg_t *MsgPtr);
int32 CFE_SB_PassMsg(CFE_SB_Msg_t *MsgPtr);
/*****************************************************************************/
-/**
+/**
** \brief Receive a message from a software bus pipe
**
** \par Description
-** This routine retrieves the next message from the specified pipe.
-** If the pipe is empty, this routine will block until either a new
+** This routine retrieves the next message from the specified pipe.
+** If the pipe is empty, this routine will block until either a new
** message comes in or the timeout value is reached.
**
** \par Assumptions, External Events, and Notes:
** Note - If an error occurs in this API, the *BufPtr value may be NULL or
-** random. Therefore, it is recommended that the return code be tested
+** random. Therefore, it is recommended that the return code be tested
** for CFE_SUCCESS before processing the message.
**
-** \param[in] BufPtr A pointer to a local variable of type #CFE_SB_MsgPtr_t.
-** Typically a caller declares a ptr of type CFE_SB_Msg_t
-** (i.e. CFE_SB_Msg_t *Ptr) then gives the address of that
-** pointer (&Ptr) as this parmeter. After a successful
-** receipt of a message, *BufPtr will point to the first
-** byte of the software bus message header. This should be
-** used as a read-only pointer (in systems with an MMU,
+** \param[in, out] BufPtr A pointer to a local variable of type #CFE_SB_MsgPtr_t.
+** Typically a caller declares a ptr of type CFE_SB_Msg_t
+** (i.e. CFE_SB_Msg_t *Ptr) then gives the address of that
+** pointer (&Ptr) as this parmeter. After a successful
+** receipt of a message, *BufPtr will point to the first
+** byte of the software bus message header. This should be
+** used as a read-only pointer (in systems with an MMU,
** writes to this pointer may cause a memory protection fault).
-** The *BufPtr is valid only until the next call to
-** CFE_SB_RcvMsg for the same pipe.
-**
-** \param[in] PipeId The pipe ID of the pipe containing the message to be obtained.
+** The *BufPtr is valid only until the next call to
+** CFE_SB_RcvMsg for the same pipe. \n *BufPtr is a pointer to the message obtained from the pipe. Valid
+** only until the next call to CFE_SB_RcvMsg for the same pipe.
+**
+** \param[in] PipeId The pipe ID of the pipe containing the message to be obtained.
**
** \param[in] TimeOut The number of milliseconds to wait for a new message if the
** pipe is empty at the time of the call. This can also be set
-** to #CFE_SB_POLL for a non-blocking receive or
+** to #CFE_SB_POLL for a non-blocking receive or
** #CFE_SB_PEND_FOREVER to wait forever for a message to arrive.
**
-** \param[out] *BufPtr A pointer to the message obtained from the pipe. Valid
-** only until the next call to CFE_SB_RcvMsg for the same pipe.
-**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
** \retval #CFE_SB_BAD_ARGUMENT \copybrief CFE_SB_BAD_ARGUMENT
@@ -667,35 +663,35 @@ int32 CFE_SB_RcvMsg(CFE_SB_MsgPtr_t *BufPtr,
*/
/*****************************************************************************/
-/**
+/**
** \brief Get a buffer pointer to use for "zero copy" SB sends.
**
** \par Description
-** This routine can be used to get a pointer to one of the software bus'
-** internal memory buffers that are used for sending messages. The caller
-** can use this memory buffer to build an SB message, then send it using
-** the #CFE_SB_ZeroCopySend function. This interface is more complicated
-** than the normal #CFE_SB_ZeroCopySend interface, but it avoids an extra
-** copy of the message from the user's memory buffer to the software bus
-** internal buffer. The "zero copy" interface can be used to improve
+** This routine can be used to get a pointer to one of the software bus'
+** internal memory buffers that are used for sending messages. The caller
+** can use this memory buffer to build an SB message, then send it using
+** the #CFE_SB_ZeroCopySend function. This interface is more complicated
+** than the normal #CFE_SB_ZeroCopySend interface, but it avoids an extra
+** copy of the message from the user's memory buffer to the software bus
+** internal buffer. The "zero copy" interface can be used to improve
** performance in high-rate, high-volume software bus traffic.
**
** \par Assumptions, External Events, and Notes:
-** -# The pointer returned by #CFE_SB_ZeroCopyGetPtr is only good for one
-** call to #CFE_SB_ZeroCopySend.
-** -# Applications should be written as if #CFE_SB_ZeroCopyGetPtr is
-** equivalent to a \c malloc() and #CFE_SB_ZeroCopySend is equivalent to
+** -# The pointer returned by #CFE_SB_ZeroCopyGetPtr is only good for one
+** call to #CFE_SB_ZeroCopySend.
+** -# Applications should be written as if #CFE_SB_ZeroCopyGetPtr is
+** equivalent to a \c malloc() and #CFE_SB_ZeroCopySend is equivalent to
** a \c free().
-** -# Applications must not de-reference the message pointer (for reading
-** or writing) after the call to #CFE_SB_ZeroCopySend.
+** -# Applications must not de-reference the message pointer (for reading
+** or writing) after the call to #CFE_SB_ZeroCopySend.
**
-** \param[in] MsgSize The size of the SB message buffer the caller wants
-** (including the SB message header).
+** \param[in] MsgSize The size of the SB message buffer the caller wants
+** (including the SB message header).
**
** \param[out] BufferHandle A handle that must be supplied when sending or releasing
-** in zero copy mode.
+** in zero copy mode.
**
-** \return A pointer to a memory buffer that can be used to build one SB message
+** \return A pointer to a memory buffer that can be used to build one SB message
** for use with #CFE_SB_ZeroCopySend.
**
** \sa #CFE_SB_ZeroCopyReleasePtr, #CFE_SB_ZeroCopySend
@@ -704,25 +700,25 @@ CFE_SB_Msg_t *CFE_SB_ZeroCopyGetPtr(uint16 MsgSize,
CFE_SB_ZeroCopyHandle_t *BufferHandle);
/*****************************************************************************/
-/**
+/**
** \brief Release an unused "zero copy" buffer pointer.
**
** \par Description
-** This routine can be used to release a pointer to one of the software
+** This routine can be used to release a pointer to one of the software
** bus' internal memory buffers.
**
** \par Assumptions, External Events, and Notes:
-** -# This function is not needed for normal "zero copy" transfers. It
-** is needed only for cleanup when an application gets a pointer using
-** #CFE_SB_ZeroCopyGetPtr, but (due to some error condition) never uses
-** that pointer for a #CFE_SB_ZeroCopySend
+** -# This function is not needed for normal "zero copy" transfers. It
+** is needed only for cleanup when an application gets a pointer using
+** #CFE_SB_ZeroCopyGetPtr, but (due to some error condition) never uses
+** that pointer for a #CFE_SB_ZeroCopySend
**
-** \param[in] Ptr2Release A pointer to the SB internal buffer. This must be a
-** pointer returned by a call to #CFE_SB_ZeroCopyGetPtr,
-** but never used in a call to #CFE_SB_ZeroCopySend.
+** \param[in] Ptr2Release A pointer to the SB internal buffer. This must be a
+** pointer returned by a call to #CFE_SB_ZeroCopyGetPtr,
+** but never used in a call to #CFE_SB_ZeroCopySend.
**
-** \param[in] BufferHandle This must be the handle supplied with the pointer
-** when #CFE_SB_ZeroCopyGetPtr was called.
+** \param[in] BufferHandle This must be the handle supplied with the pointer
+** when #CFE_SB_ZeroCopyGetPtr was called.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -734,33 +730,33 @@ int32 CFE_SB_ZeroCopyReleasePtr(CFE_SB_Msg_t *Ptr2Release,
CFE_SB_ZeroCopyHandle_t BufferHandle);
/*****************************************************************************/
-/**
+/**
** \brief Send an SB message in "zero copy" mode.
**
** \par Description
-** This routine sends a message that has been created directly in an
-** internal SB message buffer by an application (after a call to
-** #CFE_SB_ZeroCopyGetPtr). This interface is more complicated than
-** the normal #CFE_SB_SendMsg interface, but it avoids an extra copy of
-** the message from the user's memory buffer to the software bus
-** internal buffer. The "zero copy" interface can be used to improve
+** This routine sends a message that has been created directly in an
+** internal SB message buffer by an application (after a call to
+** #CFE_SB_ZeroCopyGetPtr). This interface is more complicated than
+** the normal #CFE_SB_SendMsg interface, but it avoids an extra copy of
+** the message from the user's memory buffer to the software bus
+** internal buffer. The "zero copy" interface can be used to improve
** performance in high-rate, high-volume software bus traffic.
**
** \par Assumptions, External Events, and Notes:
-** -# The pointer returned by #CFE_SB_ZeroCopyGetPtr is only good for
-** one call to #CFE_SB_ZeroCopySend.
-** -# Callers must not use the same SB message buffer for multiple sends.
-** -# Applications should be written as if #CFE_SB_ZeroCopyGetPtr is
-** equivalent to a \c malloc() and #CFE_SB_ZeroCopySend is equivalent
-** to a \c free().
-** -# Applications must not de-reference the message pointer (for reading
-** or writing) after the call to #CFE_SB_ZeroCopySend.
-** -# This function tracks and increments the source sequence counter
+** -# The pointer returned by #CFE_SB_ZeroCopyGetPtr is only good for
+** one call to #CFE_SB_ZeroCopySend.
+** -# Callers must not use the same SB message buffer for multiple sends.
+** -# Applications should be written as if #CFE_SB_ZeroCopyGetPtr is
+** equivalent to a \c malloc() and #CFE_SB_ZeroCopySend is equivalent
+** to a \c free().
+** -# Applications must not de-reference the message pointer (for reading
+** or writing) after the call to #CFE_SB_ZeroCopySend.
+** -# This function tracks and increments the source sequence counter
** of a telemetry message.
**
-** \param[in] MsgPtr A pointer to the SB message to be sent.
+** \param[in] MsgPtr A pointer to the SB message to be sent.
**
-** \param[in] BufferHandle The handle supplied with the #CFE_SB_ZeroCopyGetPtr call.
+** \param[in] BufferHandle The handle supplied with the #CFE_SB_ZeroCopyGetPtr call.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -769,41 +765,41 @@ int32 CFE_SB_ZeroCopyReleasePtr(CFE_SB_Msg_t *Ptr2Release,
** \retval #CFE_SB_BUF_ALOC_ERR \copybrief CFE_SB_BUF_ALOC_ERR
** \retval #CFE_SB_BUFFER_INVALID \copybrief CFE_SB_BUFFER_INVALID
**
-** \sa #CFE_SB_SendMsg, #CFE_SB_RcvMsg, #CFE_SB_ZeroCopyReleasePtr, #CFE_SB_ZeroCopyGetPtr
+** \sa #CFE_SB_SendMsg, #CFE_SB_RcvMsg, #CFE_SB_ZeroCopyReleasePtr, #CFE_SB_ZeroCopyGetPtr
**/
int32 CFE_SB_ZeroCopySend(CFE_SB_Msg_t *MsgPtr,
CFE_SB_ZeroCopyHandle_t BufferHandle);
/*****************************************************************************/
-/**
+/**
** \brief Pass an SB message in "zero copy" mode.
**
** \par Description
-** This routine sends a message that has been created directly in an
-** internal SB message buffer by an application (after a call to
-** #CFE_SB_ZeroCopyGetPtr). This interface is more complicated than
-** the normal #CFE_SB_SendMsg interface, but it avoids an extra copy of
-** the message from the user's memory buffer to the software bus
-** internal buffer. The "zero copy" interface can be used to improve
-** performance in high-rate, high-volume software bus traffic. This
+** This routine sends a message that has been created directly in an
+** internal SB message buffer by an application (after a call to
+** #CFE_SB_ZeroCopyGetPtr). This interface is more complicated than
+** the normal #CFE_SB_SendMsg interface, but it avoids an extra copy of
+** the message from the user's memory buffer to the software bus
+** internal buffer. The "zero copy" interface can be used to improve
+** performance in high-rate, high-volume software bus traffic. This
** version is intended to pass messages not generated by the caller
** (to preserve the source sequence count).
**
** \par Assumptions, External Events, and Notes:
-** -# The pointer returned by #CFE_SB_ZeroCopyGetPtr is only good for
-** one call to #CFE_SB_ZeroCopySend or #CFE_SB_ZeroCopyPass.
-** -# Callers must not use the same SB message buffer for multiple sends.
-** -# Applications should be written as if #CFE_SB_ZeroCopyGetPtr is
-** equivalent to a \c malloc() and #CFE_SB_ZeroCopyPass is equivalent
-** to a \c free().
-** -# Applications must not de-reference the message pointer (for reading
-** or writing) after the call to #CFE_SB_ZeroCopyPass.
+** -# The pointer returned by #CFE_SB_ZeroCopyGetPtr is only good for
+** one call to #CFE_SB_ZeroCopySend or #CFE_SB_ZeroCopyPass.
+** -# Callers must not use the same SB message buffer for multiple sends.
+** -# Applications should be written as if #CFE_SB_ZeroCopyGetPtr is
+** equivalent to a \c malloc() and #CFE_SB_ZeroCopyPass is equivalent
+** to a \c free().
+** -# Applications must not de-reference the message pointer (for reading
+** or writing) after the call to #CFE_SB_ZeroCopyPass.
** -# Unlike #CFE_SB_ZeroCopySend this routine will preserve the source
** sequence counter in a telemetry message.
**
-** \param[in] MsgPtr A pointer to the SB message to be sent.
+** \param[in] MsgPtr A pointer to the SB message to be sent.
**
-** \param[in] BufferHandle The handle supplied with the #CFE_SB_ZeroCopyGetPtr call.
+** \param[in] BufferHandle The handle supplied with the #CFE_SB_ZeroCopyGetPtr call.
**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
@@ -812,7 +808,7 @@ int32 CFE_SB_ZeroCopySend(CFE_SB_Msg_t *MsgPtr,
** \retval #CFE_SB_BUF_ALOC_ERR \copybrief CFE_SB_BUF_ALOC_ERR
** \retval #CFE_SB_BUFFER_INVALID \copybrief CFE_SB_BUFFER_INVALID
**
-** \sa #CFE_SB_PassMsg, #CFE_SB_ZeroCopySend, #CFE_SB_ZeroCopyReleasePtr, #CFE_SB_ZeroCopyGetPtr
+** \sa #CFE_SB_PassMsg, #CFE_SB_ZeroCopySend, #CFE_SB_ZeroCopyReleasePtr, #CFE_SB_ZeroCopyGetPtr
**/
int32 CFE_SB_ZeroCopyPass(CFE_SB_Msg_t *MsgPtr,
CFE_SB_ZeroCopyHandle_t BufferHandle);
@@ -823,24 +819,24 @@ int32 CFE_SB_ZeroCopyPass(CFE_SB_Msg_t *MsgPtr,
*/
/*****************************************************************************/
-/**
+/**
** \brief Initialize a buffer for a software bus message.
**
** \par Description
-** This routine fills in the header information needed to create a
+** This routine fills in the header information needed to create a
** valid software bus message.
**
** \par Assumptions, External Events, and Notes:
-** None
+** None
**
-** \param[in] MsgPtr A pointer to the buffer that will contain the message.
-** This will point to the first byte of the message header.
+** \param[in] MsgPtr A pointer to the buffer that will contain the message.
+** This will point to the first byte of the message header.
** The \c void* data type allows the calling routine to use
-** any data type when declaring its message buffer.
+** any data type when declaring its message buffer.
**
** \param[in] MsgId The message ID to put in the message header.
**
-** \param[in] Length The total number of bytes of message data, including the SB
+** \param[in] Length The total number of bytes of message data, including the SB
** message header .
**
** \param[in] Clear A flag indicating whether to clear the rest of the message:
@@ -848,7 +844,7 @@ int32 CFE_SB_ZeroCopyPass(CFE_SB_Msg_t *MsgPtr,
** \arg false - leave sequence count and packet data unchanged.
**
** \sa #CFE_SB_SetMsgId, #CFE_SB_SetUserDataLength, #CFE_SB_SetTotalMsgLength,
-** #CFE_SB_SetMsgTime, #CFE_SB_TimeStampMsg, #CFE_SB_SetCmdCode
+** #CFE_SB_SetMsgTime, #CFE_SB_TimeStampMsg, #CFE_SB_SetCmdCode
**/
void CFE_SB_InitMsg(void *MsgPtr,
CFE_SB_MsgId_t MsgId,
@@ -870,7 +866,6 @@ void CFE_SB_InitMsg(void *MsgPtr,
**
** \param[in] MsgId The message ID to put into the message header.
**
-** \return The software bus Message ID from the message header.
**
** \sa #CFE_SB_GetMsgId, #CFE_SB_SetUserDataLength, #CFE_SB_SetTotalMsgLength,
** #CFE_SB_SetMsgTime, #CFE_SB_TimeStampMsg, #CFE_SB_SetCmdCode, #CFE_SB_InitMsg
@@ -1050,17 +1045,17 @@ int32 CFE_SB_MessageStringSet(char *DestStringPtr, const char *SourceStringPtr,
*/
/*****************************************************************************/
-/**
+/**
** \brief Get a pointer to the user data portion of a software bus message.
**
** \par Description
-** This routine returns a pointer to the user data portion of a software
-** bus message. SB message header formats can be different for each
-** deployment of the cFE. So, applications should use this function and
+** This routine returns a pointer to the user data portion of a software
+** bus message. SB message header formats can be different for each
+** deployment of the cFE. So, applications should use this function and
** avoid hard coding offsets into their SB message buffers.
**
** \par Assumptions, External Events, and Notes:
-** None
+** None
**
** \param[in] MsgPtr A pointer to the buffer that contains the software bus message.
**
@@ -1072,14 +1067,14 @@ int32 CFE_SB_MessageStringSet(char *DestStringPtr, const char *SourceStringPtr,
void *CFE_SB_GetUserData(CFE_SB_MsgPtr_t MsgPtr);
/*****************************************************************************/
-/**
+/**
** \brief Get the message ID of a software bus message.
**
** \par Description
** This routine returns the message ID from a software bus message.
**
** \par Assumptions, External Events, and Notes:
-** None
+** None
**
** \param[in] MsgPtr A pointer to the buffer that contains the software bus message.
**
@@ -1091,17 +1086,17 @@ void *CFE_SB_GetUserData(CFE_SB_MsgPtr_t MsgPtr);
CFE_SB_MsgId_t CFE_SB_GetMsgId(const CFE_SB_Msg_t *MsgPtr);
/*****************************************************************************/
-/**
+/**
** \brief Gets the length of user data in a software bus message.
**
** \par Description
** This routine returns the size of the user data in a software bus message.
**
** \par Assumptions, External Events, and Notes:
-** None
+** None
**
** \param[in] MsgPtr A pointer to the buffer that contains the software bus message.
-** This must point to the first byte of the message header.
+** This must point to the first byte of the message header.
**
** \return The size (in bytes) of the user data in the software bus message.
**
@@ -1111,15 +1106,15 @@ CFE_SB_MsgId_t CFE_SB_GetMsgId(const CFE_SB_Msg_t *MsgPtr);
uint16 CFE_SB_GetUserDataLength(const CFE_SB_Msg_t *MsgPtr);
/*****************************************************************************/
-/**
+/**
** \brief Gets the total length of a software bus message.
**
** \par Description
-** This routine returns the total size of the software bus message.
+** This routine returns the total size of the software bus message.
**
** \par Assumptions, External Events, and Notes:
** - For the CCSDS implementation of this API, the size is derived from
-** the message header.
+** the message header.
**
** \param[in] MsgPtr A pointer to the buffer that contains the software bus message.
** This must point to the first byte of the message header.
@@ -1156,21 +1151,21 @@ uint16 CFE_SB_GetTotalMsgLength(const CFE_SB_Msg_t *MsgPtr);
uint16 CFE_SB_GetCmdCode(CFE_SB_MsgPtr_t MsgPtr);
/*****************************************************************************/
-/**
+/**
** \brief Gets the time field from a software bus message.
**
** \par Description
-** This routine gets the time from a software bus message.
+** This routine gets the time from a software bus message.
**
** \par Assumptions, External Events, and Notes:
-** - If the underlying implementation of software bus messages does not
-** include a time field, then this routine will return a zero time.
+** - If the underlying implementation of software bus messages does not
+** include a time field, then this routine will return a zero time.
** - Note default implementation of command messages do not have a time field.
**
** \param[in] MsgPtr A pointer to the buffer that contains the software bus message.
-** This must point to the first byte of the message header.
+** This must point to the first byte of the message header.
**
-** \return The system time included in the software bus message header (if present),
+** \return The system time included in the software bus message header (if present),
** otherwise, returns a time value of zero.
**
** \sa #CFE_SB_GetUserData, #CFE_SB_GetMsgId, #CFE_SB_GetUserDataLength, #CFE_SB_GetTotalMsgLength,
@@ -1256,20 +1251,20 @@ int32 CFE_SB_MessageStringGet(char *DestStringPtr, const char *SourceStringPtr,
*/
/*****************************************************************************/
-/**
+/**
** \brief Gets the checksum field from a software bus message.
**
** \par Description
-** This routine gets the checksum (or other message integrity check
-** value) from a software bus message. The contents and location of
-** this field will depend on the underlying implementation of software
-** bus messages. It may be a checksum, a CRC, or some other algorithm.
-** Users should not call this function as part of a message integrity
-** check (call #CFE_SB_ValidateChecksum instead).
+** This routine gets the checksum (or other message integrity check
+** value) from a software bus message. The contents and location of
+** this field will depend on the underlying implementation of software
+** bus messages. It may be a checksum, a CRC, or some other algorithm.
+** Users should not call this function as part of a message integrity
+** check (call #CFE_SB_ValidateChecksum instead).
**
** \par Assumptions, External Events, and Notes:
-** - If the underlying implementation of software bus messages does not
-** include a checksum field, then this routine will return a zero.
+** - If the underlying implementation of software bus messages does not
+** include a checksum field, then this routine will return a zero.
**
** \param[in] MsgPtr A pointer to the buffer that contains the software bus message.
** This must point to the first byte of the message header.
@@ -1279,24 +1274,24 @@ int32 CFE_SB_MessageStringGet(char *DestStringPtr, const char *SourceStringPtr,
**
** \sa #CFE_SB_GetUserData, #CFE_SB_GetMsgId, #CFE_SB_GetUserDataLength, #CFE_SB_GetTotalMsgLength,
** #CFE_SB_GetMsgTime, #CFE_SB_GetCmdCode, #CFE_SB_GetChecksum
-** #CFE_SB_ValidateChecksum, #CFE_SB_GenerateChecksum
+** #CFE_SB_ValidateChecksum, #CFE_SB_GenerateChecksum
**/
uint16 CFE_SB_GetChecksum(CFE_SB_MsgPtr_t MsgPtr);
/*****************************************************************************/
-/**
+/**
** \brief Calculates and sets the checksum of a software bus message
**
** \par Description
-** This routine calculates the checksum of a software bus message according
-** to an implementation-defined algorithm. Then, it sets the checksum field
-** in the message with the calculated value. The contents and location of
-** this field will depend on the underlying implementation of software bus
-** messages. It may be a checksum, a CRC, or some other algorithm.
+** This routine calculates the checksum of a software bus message according
+** to an implementation-defined algorithm. Then, it sets the checksum field
+** in the message with the calculated value. The contents and location of
+** this field will depend on the underlying implementation of software bus
+** messages. It may be a checksum, a CRC, or some other algorithm.
**
** \par Assumptions, External Events, and Notes:
-** - If the underlying implementation of software bus messages does not
-** include a checksum field, then this routine will do nothing.
+** - If the underlying implementation of software bus messages does not
+** include a checksum field, then this routine will do nothing.
**
** \param[in] MsgPtr A pointer to the buffer that contains the software bus message.
** This must point to the first byte of the message header.
@@ -1306,19 +1301,19 @@ uint16 CFE_SB_GetChecksum(CFE_SB_MsgPtr_t MsgPtr);
void CFE_SB_GenerateChecksum(CFE_SB_MsgPtr_t MsgPtr);
/*****************************************************************************/
-/**
+/**
** \brief Validates the checksum of a software bus message.
**
** \par Description
-** This routine calculates the expected checksum of a software bus message
-** according to an implementation-defined algorithm. Then, it checks the
-** calculated value against the value in the message's checksum. If the
-** checksums do not match, this routine will generate an event message
-** reporting the error.
+** This routine calculates the expected checksum of a software bus message
+** according to an implementation-defined algorithm. Then, it checks the
+** calculated value against the value in the message's checksum. If the
+** checksums do not match, this routine will generate an event message
+** reporting the error.
**
** \par Assumptions, External Events, and Notes:
-** - If the underlying implementation of software bus messages does not
-** include a checksum field, then this routine will always return \c true.
+** - If the underlying implementation of software bus messages does not
+** include a checksum field, then this routine will always return \c true.
**
** \param[in] MsgPtr A pointer to the buffer that contains the software bus message.
** This must point to the first byte of the message header.
diff --git a/fsw/cfe-core/src/inc/cfe_sb_msg.h b/fsw/cfe-core/src/inc/cfe_sb_msg.h
index c43f5b838..d7a7d0fda 100644
--- a/fsw/cfe-core/src/inc/cfe_sb_msg.h
+++ b/fsw/cfe-core/src/inc/cfe_sb_msg.h
@@ -367,7 +367,8 @@
/** \cfesbcmd Enable Subscription Reporting Command
**
-** \par This command will enable subscription reporting and is intended to
+** \par Description
+** This command will enable subscription reporting and is intended to
** be used only by the CFS SBN (Software Bus Networking) Application.
** It is not intended to be sent from the ground or used by operations.
** When subscription reporting is enabled, SB will generate
@@ -399,7 +400,8 @@
/** \cfesbcmd Disable Subscription Reporting Command
**
-** \par This command will disable subscription reporting and is intended to
+** \par Description
+** This command will disable subscription reporting and is intended to
** be used only by the CFS SBN (Software Bus Networking) Application.
** It is not intended to be sent from the ground or used by operations.
** When subscription reporting is enabled, SB will generate
diff --git a/fsw/cfe-core/src/inc/cfe_tbl.h b/fsw/cfe-core/src/inc/cfe_tbl.h
index ab0adc49b..88fecd553 100644
--- a/fsw/cfe-core/src/inc/cfe_tbl.h
+++ b/fsw/cfe-core/src/inc/cfe_tbl.h
@@ -165,9 +165,10 @@ typedef struct
** their own tables. An application should create any table(s) and provide the handle(s)
** to the interrupt service routine.
**
-** \param[in] TblHandlePtr a pointer to a #CFE_TBL_Handle_t type variable that will be assigned the
+** \param[in, out] TblHandlePtr a pointer to a #CFE_TBL_Handle_t type variable that will be assigned the
** table's handle. The table handle is required for other API calls when
-** accessing the data contained in the table.
+** accessing the data contained in the table. *TblHandlePtr is the handle used to identify table to cFE when performing Table operations.
+** This value is returned at the address specified by TblHandlePtr.
**
** \param[in] Name The application-specific name. This name will be combined with the name of the
** application to produce a processor specific name of the form
@@ -264,9 +265,6 @@ typedef struct
** will be executed in the Application's context so that Event Messages describing the
** validation failure are possible from within the function.
**
-** \param[out] *TblHandlePtr Handle used to identify table to cFE when performing Table operations.
-** This value is returned at the address specified by TblHandlePtr.
-**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
** \retval #CFE_TBL_INFO_RECOVERED_TBL \copybrief CFE_TBL_INFO_RECOVERED_TBL
@@ -301,10 +299,11 @@ int32 CFE_TBL_Register( CFE_TBL_Handle_t *TblHandlePtr, /* Ret
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] TblHandlePtr A pointer to a #CFE_TBL_Handle_t type variable
+** \param[in, out] TblHandlePtr A pointer to a #CFE_TBL_Handle_t type variable
** that will be assigned the table's handle. The
** table handle is required for other API calls
-** when accessing the data contained in the table.
+** when accessing the data contained in the table. *TblHandlePtr is the handle used to identify table to cFE when performing Table operations.
+** This value is returned at the address specified by TblHandlePtr.
**
** \param[in] TblName The processor specific name of the table. It is important to note
** that the processor specific table name is different from the table
@@ -314,9 +313,6 @@ int32 CFE_TBL_Register( CFE_TBL_Handle_t *TblHandlePtr, /* Ret
** An example of this would be "ACS.TamParams" for a table called "TamParams"
** that was registered by the application called "ACS".
**
-** \param[out] *TblHandlePtr Handle used to identify table to cFE when performing Table operations.
-** This value is returned at the address specified by TblHandlePtr.
-**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
** \retval #CFE_TBL_ERR_HANDLES_FULL \copybrief CFE_TBL_ERR_HANDLES_FULL
@@ -607,15 +603,13 @@ int32 CFE_TBL_Modified( CFE_TBL_Handle_t TblHandle );
** This pointer mush be released with the #CFE_TBL_ReleaseAddress API before
** the table can be loaded with data.
**
-** \param[in] TblPtr The address of a pointer that will be loaded with the address of
+** \param[in, out] TblPtr The address of a pointer that will be loaded with the address of
** the first byte of the table. This pointer can then be typecast
-** by the calling application to the appropriate table data structure.
+** by the calling application to the appropriate table data structure. *TblPtr is the address of the first byte of data associated with the specified table.
**
** \param[in] TblHandle Handle, previously obtained from #CFE_TBL_Register or #CFE_TBL_Share, that
** identifies the Table whose address is to be returned.
**
-** \param[out] *TblPtr Address of the first byte of data associated with the specified table.
-**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
** \retval #CFE_TBL_INFO_UPDATED \copybrief CFE_TBL_INFO_UPDATED
@@ -692,17 +686,15 @@ int32 CFE_TBL_ReleaseAddress( CFE_TBL_Handle_t TblHandle );
** This pointer mush be released with the #CFE_TBL_ReleaseAddress API before
** the table can be loaded with data.
**
-** \param[in] TblPtrs Array of Pointers to variables that calling Application
-** wishes to hold the start addresses of the Tables.
+** \param[in, out] TblPtrs Array of Pointers to variables that calling Application
+** wishes to hold the start addresses of the Tables. *TblPtrs is an array of addresses of the first byte of data associated with the
+** specified tables.
**
** \param[in] NumTables Size of TblPtrs and TblHandles arrays.
**
** \param[in] TblHandles Array of Table Handles, previously obtained from #CFE_TBL_Register or #CFE_TBL_Share,
** of those tables whose start addresses are to be obtained.
**
-** \param[out] *TblPtrs Array of addresses of the first byte of data associated with the
-** specified tables.
-**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
** \retval #CFE_TBL_INFO_UPDATED \copybrief CFE_TBL_INFO_UPDATED
@@ -807,8 +799,9 @@ int32 CFE_TBL_GetStatus( CFE_TBL_Handle_t TblHandle );
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] TblInfoPtr A pointer to a CFE_TBL_Info_t data structure that is to be populated
-** with table characteristics and information.
+** \param[in, out] TblInfoPtr A pointer to a CFE_TBL_Info_t data structure that is to be populated
+** with table characteristics and information. *TblInfoPtr is the description of the tables characteristics and registry information stored in
+** the #CFE_TBL_Info_t data structure format.
**
** \param[in] TblName The processor specific name of the table. It is important to note
** that the processor specific table name is different from the table
@@ -818,9 +811,6 @@ int32 CFE_TBL_GetStatus( CFE_TBL_Handle_t TblHandle );
** An example of this would be "ACS.TamParams" for a table called "TamParams"
** that was registered by the application called "ACS".
**
-** \param[out] *TblInfoPtr Description of the tables characteristics and registry information stored in
-** the #CFE_TBL_Info_t data structure format.
-**
** \return Execution status, see \ref CFEReturnCodes
** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
** \retval #CFE_TBL_ERR_INVALID_NAME \copybrief CFE_TBL_ERR_INVALID_NAME
diff --git a/fsw/cfe-core/src/inc/cfe_tbl_events.h b/fsw/cfe-core/src/inc/cfe_tbl_events.h
index 8906b5d08..e1b56fc48 100644
--- a/fsw/cfe-core/src/inc/cfe_tbl_events.h
+++ b/fsw/cfe-core/src/inc/cfe_tbl_events.h
@@ -66,6 +66,8 @@
** Task completes its Initialization.
**/
#define CFE_TBL_INIT_INF_EID 1
+/** \} */
+
/** \name Command Response Informational Event Message IDs */
/** \{ */
@@ -841,6 +843,7 @@
#define CFE_TBL_FAIL_NOTIFY_SEND_ERR_EID 89
/** \} */
+
/** \name API Informational Event Message IDs */
/** \{ */
@@ -895,7 +898,6 @@
/** \} */
-
/** \name API Error Event Message IDs */
/** \{ */
/** \brief '\%s Failed to Register '\%s', Status=0x\%08X'
@@ -1100,7 +1102,6 @@
/** \} */
-
#endif /* _cfe_tbl_events_ */
/************************/
diff --git a/fsw/cfe-core/src/inc/cfe_time.h b/fsw/cfe-core/src/inc/cfe_time.h
index 43ff740cd..9893dd939 100644
--- a/fsw/cfe-core/src/inc/cfe_time.h
+++ b/fsw/cfe-core/src/inc/cfe_time.h
@@ -876,13 +876,11 @@ int32 CFE_TIME_UnregisterSynchCallback(CFE_TIME_SynchCallbackPtr_t CallbackFunc
** the maximum amount of time represented by a CFE_TIME_SysTime
** structure is approximately 136 years.
**
-** \param[in] PrintBuffer Pointer to a character array of at least
-** #CFE_TIME_PRINTED_STRING_SIZE characters in length
+** \param[in, out] PrintBuffer Pointer to a character array of at least
+** #CFE_TIME_PRINTED_STRING_SIZE characters in length. *PrintBuffer is the time as a character string as described above.
**
** \param[in] TimeToPrint The time to print into the character array.
**
-** \param[out] *PrintBuffer The time as a character string as described above.
-**
******************************************************************************/
void CFE_TIME_Print(char *PrintBuffer, CFE_TIME_SysTime_t TimeToPrint);
diff --git a/fsw/cfe-core/src/inc/private/cfe_private.h b/fsw/cfe-core/src/inc/private/cfe_private.h
index 1400e20af..11f38014b 100644
--- a/fsw/cfe-core/src/inc/private/cfe_private.h
+++ b/fsw/cfe-core/src/inc/private/cfe_private.h
@@ -52,7 +52,7 @@
** \par Assumptions, External Events, and Notes:
** None
**
-** \retval None
+**
******************************************************************************/
extern void CFE_TIME_TaskMain(void);
@@ -66,7 +66,7 @@ extern void CFE_TIME_TaskMain(void);
** \par Assumptions, External Events, and Notes:
** None
**
-** \retval None
+**
******************************************************************************/
extern void CFE_SB_TaskMain(void);
@@ -80,7 +80,7 @@ extern void CFE_SB_TaskMain(void);
** \par Assumptions, External Events, and Notes:
** None
**
-** \retval None
+**
******************************************************************************/
extern void CFE_EVS_TaskMain(void);
@@ -94,7 +94,7 @@ extern void CFE_EVS_TaskMain(void);
** \par Assumptions, External Events, and Notes:
** None
**
-** \retval None
+**
******************************************************************************/
extern void CFE_ES_TaskMain(void);
@@ -110,7 +110,7 @@ extern void CFE_ES_TaskMain(void);
** \par Assumptions, External Events, and Notes:
** None
**
-** \retval None
+**
******************************************************************************/
extern void CFE_TBL_TaskMain(void);
@@ -290,7 +290,7 @@ extern int32 CFE_TIME_CleanUpApp(uint32 AppId);
** -# This function assumes input parameters are error free and have met size/value restrictions.
** -# The calling function is responsible for issuing any event messages associated with errors.
**
-** \param[in] HandlePtr Pointer Application's variable that will contain the CDS Memory Block Handle.
+** \param[in, out] HandlePtr Pointer Application's variable that will contain the CDS Memory Block Handle. *HandlePtr is the handle of the CDS block that can be used in #CFE_ES_CopyToCDS and #CFE_ES_RestoreFromCDS.
**
** \param[in] BlockSize The number of bytes needed in the CDS.
**
@@ -299,7 +299,6 @@ extern int32 CFE_TIME_CleanUpApp(uint32 AppId);
**
** \param[in] CriticalTbl Indicates whether the CDS is to be used as a Critical Table or not
**
-** \param[out] *HandlePtr The handle of the CDS block that can be used in #CFE_ES_CopyToCDS and #CFE_ES_RestoreFromCDS.
**
** \return See return codes for #CFE_ES_RegisterCDS
**
diff --git a/fsw/cfe-core/src/sb/cfe_sb_priv.h b/fsw/cfe-core/src/sb/cfe_sb_priv.h
index c70dcec82..86201fd47 100644
--- a/fsw/cfe-core/src/sb/cfe_sb_priv.h
+++ b/fsw/cfe-core/src/sb/cfe_sb_priv.h
@@ -401,33 +401,31 @@ int32 CFE_SB_RemoveDest(CFE_SB_RouteEntry_t *RouteEntry, CFE_SB_DestinationD_t *
/*****************************************************************************/
-/**
+/**
** \brief Get the size of a software bus message header.
**
** \par Description
-** This routine returns the number of bytes in a software bus message header.
-** This can be used for sizing buffers that need to store SB messages. SB
-** message header formats can be different for each deployment of the cFE.
-** So, applications should use this function and avoid hard coding their buffer
+** This routine returns the number of bytes in a software bus message header.
+** This can be used for sizing buffers that need to store SB messages. SB
+** message header formats can be different for each deployment of the cFE.
+** So, applications should use this function and avoid hard coding their buffer
** sizes.
**
** \par Assumptions, External Events, and Notes:
-** - For statically defined messages, a function call will not work. The
-** macros #CFE_SB_CMD_HDR_SIZE and #CFE_SB_TLM_HDR_SIZE are available for use
-** in static message buffer sizing or structure definitions.
+** - For statically defined messages, a function call will not work. The
+** macros #CFE_SB_CMD_HDR_SIZE and #CFE_SB_TLM_HDR_SIZE are available for use
+** in static message buffer sizing or structure definitions.
**
-** \param[in] *MsgPtr The message ID to calculate header size for. The size of the message
-** header may depend on the MsgId in some implementations. For example,
-** if SB messages are implemented as CCSDS packets, the size of the header
+** \param[in] *MsgPtr The message ID to calculate header size for. The size of the message
+** header may depend on the MsgId in some implementations. For example,
+** if SB messages are implemented as CCSDS packets, the size of the header
** is different for command vs. telemetry packets.
**
-** \returns
-** \retstmt The number of bytes in the software bus message header for
-** messages with the given \c MsgId. endstmt
-** \endreturns
+** \returns The number of bytes in the software bus message header for
+** messages with the given \c MsgId.
**
** \sa #CFE_SB_GetUserData, #CFE_SB_GetMsgId, #CFE_SB_GetUserDataLength, #CFE_SB_GetTotalMsgLength,
-** #CFE_SB_GetMsgTime, #CFE_SB_GetCmdCode, #CFE_SB_GetChecksum
+** #CFE_SB_GetMsgTime, #CFE_SB_GetCmdCode, #CFE_SB_GetChecksum
**/
uint16 CFE_SB_MsgHdrSize(const CFE_SB_Msg_t *MsgPtr);
diff --git a/fsw/cfe-core/src/tbl/cfe_tbl_internal.h b/fsw/cfe-core/src/tbl/cfe_tbl_internal.h
index b09bb54a3..42f788cee 100644
--- a/fsw/cfe-core/src/tbl/cfe_tbl_internal.h
+++ b/fsw/cfe-core/src/tbl/cfe_tbl_internal.h
@@ -59,9 +59,8 @@
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] AppIdPtr Pointer to value that will hold AppID on return.
+** \param[in, out] AppIdPtr Pointer to value that will hold AppID on return. *AppIdPtr is the AppID as obtained from #CFE_ES_GetAppID
**
-** \param[out] *AppIdPtr The AppID as obtained from #CFE_ES_GetAppID
**
** \retval #CFE_SUCCESS \copydoc CFE_SUCCESS
** \retval #CFE_TBL_ERR_BAD_APP_ID \copydoc CFE_TBL_ERR_BAD_APP_ID
@@ -106,9 +105,8 @@ int32 CFE_TBL_ValidateHandle(CFE_TBL_Handle_t TblHandle);
**
** \param[in] TblHandle Handle of table whose access is desired.
**
-** \param[in] AppIdPtr Pointer to value that will hold AppID on return.
+** \param[in, out] AppIdPtr Pointer to value that will hold AppID on return. *AppIdPtr is the AppID as obtained from #CFE_ES_GetAppID
**
-** \param[out] *AppIdPtr The AppID as obtained from #CFE_ES_GetAppID
**
** \retval #CFE_SUCCESS \copydoc CFE_SUCCESS
** \retval #CFE_TBL_ERR_BAD_APP_ID \copydoc CFE_TBL_ERR_BAD_APP_ID
@@ -179,11 +177,10 @@ int32 CFE_TBL_RemoveAccessLink(CFE_TBL_Handle_t TblHandle);
** this function would return #CFE_TBL_ERR_UNREGISTERED.
** -# ThisAppId parameter is assumed to be validated.
**
-** \param[in] TblPtr Pointer to pointer that will hold address of data upon return.
+** \param[in, out] TblPtr Pointer to pointer that will hold address of data upon return. *TblPtr is the address of the Table Data.
** \param[in] TblHandle Handle of Table whose address is needed.
** \param[in] ThisAppId AppID of application making the address request.
**
-** \param[out] *TblPtr Address of Table Data.
**
** \retval #CFE_SUCCESS \copydoc CFE_SUCCESS
** \retval #CFE_TBL_ERR_INVALID_HANDLE \copydoc CFE_TBL_ERR_INVALID_HANDLE
@@ -275,17 +272,16 @@ CFE_TBL_Handle_t CFE_TBL_FindFreeHandle(void);
** \par Assumptions, External Events, and Notes:
** Note: AppName portion will be truncated to OS_MAX_API_NAME.
**
-** \param[in] FullTblName pointer to character buffer of #CFE_TBL_MAX_FULL_NAME_LEN size
-** that will be filled with the processor specific Table Name.
+** \param[in, out] FullTblName pointer to character buffer of #CFE_TBL_MAX_FULL_NAME_LEN size
+** that will be filled with the processor specific Table Name. *FullTblName is the processor specific Table Name of the form "AppName.TblName".
**
** \param[in] TblName pointer to character string containing the Application's local name for
** the Table.
**
** \param[in] ThisAppId the Application ID of the Application making the call.
**
-** \param[out] *FullTblName processor specific Table Name of the form "AppName.TblName".
**
-** \retval None
+**
******************************************************************************/
void CFE_TBL_FormTableName(char *FullTblName, const char *TblName, uint32 ThisAppId);
@@ -338,8 +334,8 @@ int32 CFE_TBL_UnlockRegistry(void);
** -# This function assumes the TblHandle and MinBufferSize values
** are legitimate.
**
-** \param[in] WorkingBufferPtr Pointer to variable that will contain the
-** address of the first byte of the working buffer
+** \param[in, out] WorkingBufferPtr Pointer to variable that will contain the
+** address of the first byte of the working buffer. *WorkingBufferPtr is the address of the first byte of the working buffer
**
** \param[in] RegRecPtr Pointer to Table Registry Entry for Table for whom
** a working buffer is to be obtained
@@ -348,7 +344,6 @@ int32 CFE_TBL_UnlockRegistry(void);
** function is being called by a user Application (true)
** or by the Table Services Application (false)
**
-** \param[out] *WorkingBufferPtr Address of first byte of working buffer
**
** \retval #CFE_SUCCESS \copydoc CFE_SUCCESS
** \retval #CFE_TBL_ERR_NO_BUFFER_AVAIL \copydoc CFE_TBL_ERR_NO_BUFFER_AVAIL
@@ -459,18 +454,16 @@ void CFE_TBL_NotifyTblUsersOfUpdate( CFE_TBL_RegistryRec_t *RegRecPtr );
**
** \param[in] FileDescriptor File Descriptor, as provided by OS_fopen
**
-** \param[in] StdFileHeaderPtr Pointer to buffer to be filled with the contents
-** of the file's standard cFE Header
+** \param[in, out] StdFileHeaderPtr Pointer to buffer to be filled with the contents
+** of the file's standard cFE Header. *StdFileHeaderPtr is the contents of the standard cFE File Header
**
-** \param[in] TblFileHeaderPtr Pointer to buffer to be filled with the contents
-** of the file's standard cFE Table Header
+** \param[in, out] TblFileHeaderPtr Pointer to buffer to be filled with the contents
+** of the file's standard cFE Table Header. *TblFileHeaderPtr is the contents of the standard cFE Table File Header
**
** \param[in] LoadFilename Pointer to character string containing full path
** and filename of table image to be loaded
**
-** \param[out] *StdFileHeaderPtr Contents of standard cFE File Header
**
-** \param[out] *TblFileHeaderPtr Contents of standard cFE Table File Header
**
** \retval #CFE_SUCCESS \copydoc CFE_SUCCESS
** \retval #CFE_TBL_ERR_NO_STD_HEADER \copydoc CFE_TBL_ERR_NO_STD_HEADER
@@ -513,10 +506,8 @@ void CFE_TBL_InitRegistryRecord (CFE_TBL_RegistryRec_t *RegRecPtr);
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] HdrPtr Pointer to table header that needs to be swapped.
+** \param[in, out] HdrPtr Pointer to table header that needs to be swapped. *HdrPtr provides the swapped header
**
-** \param[out] *HdrPtr The swapped header
-**
**
******************************************************************************/
void CFE_TBL_ByteSwapTblHeader(CFE_TBL_File_Hdr_t *HdrPtr);
@@ -536,15 +527,14 @@ void CFE_TBL_ByteSwapTblHeader(CFE_TBL_File_Hdr_t *HdrPtr);
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] **CritRegRecPtr Pointer to a pointer that should be initialized with
+** \param[in, out] **CritRegRecPtr Pointer to a pointer that should be initialized with
** the start address of the located Critical Table Registry
-** Record.
+** Record. *CritRegRecPtr is the pointer to the start address of the located Critical
+** Table Registry Record. \c NULL if the record is not
+** found.
**
** \param[in] CDSHandleToFind CDS Handle to be located in Critical Table Registry.
**
-** \param[out] *CritRegRecPtr Pointer to the start address of the located Critical
-** Table Registry Record. \c NULL if the record is not
-** found.
**
******************************************************************************/
void CFE_TBL_FindCriticalTblInfo(CFE_TBL_CritRegRec_t **CritRegRecPtr, CFE_ES_CDSHandle_t CDSHandleToFind);
@@ -601,9 +591,7 @@ int32 CFE_TBL_SendNotificationMsg(CFE_TBL_RegistryRec_t *RegRecPtr);
** \par Assumptions, External Events, and Notes:
** None
**
-** \param[in] Uint32ToSwapPtr Pointer to uint32 value to be swapped.
-**
-** \param[out] *Uint32ToSwapPtr The swapped uint32 value
+** \param[in, out] Uint32ToSwapPtr Pointer to uint32 value to be swapped. *Uint32ToSwapPtr is the swapped uint32 value
**
**
******************************************************************************/
diff --git a/fsw/cfe-core/src/tbl/cfe_tbl_task.h b/fsw/cfe-core/src/tbl/cfe_tbl_task.h
index 44d9e2135..6cd8e5c3d 100644
--- a/fsw/cfe-core/src/tbl/cfe_tbl_task.h
+++ b/fsw/cfe-core/src/tbl/cfe_tbl_task.h
@@ -402,7 +402,7 @@ int32 CFE_TBL_TaskInit(void);
**
** \param[in] MessagePtr a pointer to the message received from the command pipe
**
-** \retval None
+**
******************************************************************************/
void CFE_TBL_TaskPipe(CFE_SB_Msg_t *MessagePtr);
@@ -416,7 +416,7 @@ void CFE_TBL_TaskPipe(CFE_SB_Msg_t *MessagePtr);
** \par Assumptions, External Events, and Notes:
** None
**
-** \retval None
+**
******************************************************************************/
void CFE_TBL_InitData(void);
diff --git a/fsw/cfe-core/src/tbl/cfe_tbl_task_cmds.h b/fsw/cfe-core/src/tbl/cfe_tbl_task_cmds.h
index c71e28810..6ffec67d7 100644
--- a/fsw/cfe-core/src/tbl/cfe_tbl_task_cmds.h
+++ b/fsw/cfe-core/src/tbl/cfe_tbl_task_cmds.h
@@ -91,7 +91,7 @@ typedef struct {
** \par Assumptions, External Events, and Notes:
** None
**
-** \retval None
+**
******************************************************************************/
extern void CFE_TBL_GetHkData(void);
@@ -108,7 +108,7 @@ extern void CFE_TBL_GetHkData(void);
** #CFE_TBL_TaskData_t::HkTlmTblRegIndex is assumed to be a valid index into
** the Table Registry.
**
-** \retval None
+**
******************************************************************************/
extern void CFE_TBL_GetTblRegData(void);
@@ -120,9 +120,9 @@ extern void CFE_TBL_GetTblRegData(void);
** Constructs a Housekeeping Packet (#CFE_TBL_HousekeepingTlm_t) from task data and sends it out
**
** \par Assumptions, External Events, and Notes:
-** The message pointed to by MessagePtr has been identified as a Housekeeping Request Message
+** The message pointed to by data has been identified as a Housekeeping Request Message
**
-** \param[in] MessagePtr points to the message received via command pipe that needs processing
+** \param[in] data points to the message received via command pipe that needs processing
**
** \retval #CFE_TBL_DONT_INC_CTR \copydoc CFE_TBL_DONT_INC_CTR
******************************************************************************/
@@ -136,9 +136,9 @@ int32 CFE_TBL_HousekeepingCmd(const CCSDS_CommandPacket_t *data);
** Responds to the NOOP command by issuing an Event Message
**
** \par Assumptions, External Events, and Notes:
-** The message pointed to by MessagePtr has been identified as a NO OP Command Message
+** The message pointed to by data has been identified as a NO OP Command Message
**
-** \param[in] MessagePtr points to the message received via command pipe that needs processing
+** \param[in] data points to the message received via command pipe that needs processing
**
** \retval #CFE_TBL_INC_ERR_CTR \copydoc CFE_TBL_INC_ERR_CTR
** \retval #CFE_TBL_INC_CMD_CTR \copydoc CFE_TBL_INC_CMD_CTR
@@ -153,9 +153,9 @@ int32 CFE_TBL_NoopCmd(const CFE_TBL_Noop_t *data);
** Resets command counters and validation request counters
**
** \par Assumptions, External Events, and Notes:
-** The message pointed to by MessagePtr has been identified as a Reset Counters Command Message
+** The message pointed to by data has been identified as a Reset Counters Command Message
**
-** \param[in] MessagePtr points to the message received via command pipe that needs processing
+** \param[in] data points to the message received via command pipe that needs processing
**
** \retval #CFE_TBL_DONT_INC_CTR \copydoc CFE_TBL_DONT_INC_CTR
******************************************************************************/
@@ -170,9 +170,9 @@ int32 CFE_TBL_ResetCountersCmd(const CFE_TBL_ResetCounters_t *data);
** a buffer that is associated with the table specified within the file header.
**
** \par Assumptions, External Events, and Notes:
-** The message pointed to by MessagePtr has been identified as a Load Table Command Message
+** The message pointed to by data has been identified as a Load Table Command Message
**
-** \param[in] MessagePtr points to the message received via command pipe that needs processing
+** \param[in] data points to the message received via command pipe that needs processing
**
** \retval #CFE_TBL_INC_ERR_CTR \copydoc CFE_TBL_INC_ERR_CTR
** \retval #CFE_TBL_INC_CMD_CTR \copydoc CFE_TBL_INC_CMD_CTR
@@ -188,9 +188,9 @@ int32 CFE_TBL_LoadCmd(const CFE_TBL_Load_t *data);
** the data contents to the command message specified file.
**
** \par Assumptions, External Events, and Notes:
-** The message pointed to by MessagePtr has been identified as a Dump Table Command Message
+** The message pointed to by data has been identified as a Dump Table Command Message
**
-** \param[in] MessagePtr points to the message received via command pipe that needs processing
+** \param[in] data points to the message received via command pipe that needs processing
**
** \retval #CFE_TBL_INC_ERR_CTR \copydoc CFE_TBL_INC_ERR_CTR
** \retval #CFE_TBL_INC_CMD_CTR \copydoc CFE_TBL_INC_CMD_CTR
@@ -207,9 +207,9 @@ int32 CFE_TBL_DumpCmd(const CFE_TBL_Dump_t *data);
** of the buffer's contents is required.
**
** \par Assumptions, External Events, and Notes:
-** The message pointed to by MessagePtr has been identified as a Validate Table Command Message
+** The message pointed to by data has been identified as a Validate Table Command Message
**
-** \param[in] MessagePtr points to the message received via command pipe that needs processing
+** \param[in] data points to the message received via command pipe that needs processing
**
** \retval #CFE_TBL_INC_ERR_CTR \copydoc CFE_TBL_INC_ERR_CTR
** \retval #CFE_TBL_INC_CMD_CTR \copydoc CFE_TBL_INC_CMD_CTR
@@ -225,9 +225,9 @@ int32 CFE_TBL_ValidateCmd(const CFE_TBL_Validate_t *data);
** be used.
**
** \par Assumptions, External Events, and Notes:
-** The message pointed to by MessagePtr has been identified as an Activate Table Command Message
+** The message pointed to by data has been identified as an Activate Table Command Message
**
-** \param[in] MessagePtr points to the message received via command pipe that needs processing
+** \param[in] data points to the message received via command pipe that needs processing
**
** \retval #CFE_TBL_INC_ERR_CTR \copydoc CFE_TBL_INC_ERR_CTR
** \retval #CFE_TBL_INC_CMD_CTR \copydoc CFE_TBL_INC_CMD_CTR
@@ -242,9 +242,9 @@ int32 CFE_TBL_ActivateCmd(const CFE_TBL_Activate_t *data);
** Copies the contents of the Table Registry to a command message specified file.
**
** \par Assumptions, External Events, and Notes:
-** The message pointed to by MessagePtr has been identified as a Dump Table Registry Command Message
+** The message pointed to by data has been identified as a Dump Table Registry Command Message
**
-** \param[in] MessagePtr points to the message received via command pipe that needs processing
+** \param[in] data points to the message received via command pipe that needs processing
**
** \retval #CFE_TBL_INC_ERR_CTR \copydoc CFE_TBL_INC_ERR_CTR
** \retval #CFE_TBL_INC_CMD_CTR \copydoc CFE_TBL_INC_CMD_CTR
@@ -260,9 +260,9 @@ int32 CFE_TBL_DumpRegistryCmd(const CFE_TBL_DumpRegistry_t *data);
** a message that is sent out.
**
** \par Assumptions, External Events, and Notes:
-** The message pointed to by MessagePtr has been identified as a Telemeter Table Registry Entry Command Message
+** The message pointed to by data has been identified as a Telemeter Table Registry Entry Command Message
**
-** \param[in] MessagePtr points to the message received via command pipe that needs processing
+** \param[in] data points to the message received via command pipe that needs processing
**
** \retval #CFE_TBL_INC_ERR_CTR \copydoc CFE_TBL_INC_ERR_CTR
** \retval #CFE_TBL_INC_CMD_CTR \copydoc CFE_TBL_INC_CMD_CTR
@@ -277,9 +277,9 @@ int32 CFE_TBL_SendRegistryCmd(const CFE_TBL_SendRegistry_t *data);
** Deletes a Critical Data Store used to hold a Critical Table's image
**
** \par Assumptions, External Events, and Notes:
-** The message pointed to by MessagePtr has been identified as a Delete CDS Command Message
+** The message pointed to by data has been identified as a Delete CDS Command Message
**
-** \param[in] MessagePtr points to the message received via command pipe that needs processing
+** \param[in] data points to the message received via command pipe that needs processing
**
** \retval #CFE_TBL_INC_ERR_CTR \copydoc CFE_TBL_INC_ERR_CTR
** \retval #CFE_TBL_INC_CMD_CTR \copydoc CFE_TBL_INC_CMD_CTR
@@ -294,9 +294,9 @@ int32 CFE_TBL_DeleteCDSCmd(const CFE_TBL_DeleteCDS_t *data);
** Frees any resources associated with a previously loaded table.
**
** \par Assumptions, External Events, and Notes:
-** The message pointed to by MessagePtr has been identified as an Abort Load Command Message
+** The message pointed to by data has been identified as an Abort Load Command Message
**
-** \param[in] MessagePtr points to the message received via command pipe that needs processing
+** \param[in] data points to the message received via command pipe that needs processing
**
** \retval #CFE_TBL_INC_ERR_CTR \copydoc CFE_TBL_INC_ERR_CTR
** \retval #CFE_TBL_INC_CMD_CTR \copydoc CFE_TBL_INC_CMD_CTR
@@ -345,7 +345,6 @@ extern CFE_TBL_CmdProcRet_t CFE_TBL_DumpToFile( const char *DumpFilename, const
**
** \param[in] RegRecPtr Pointer to registry record entry for the table whose load is to be aborted
**
-** \return None
******************************************************************************/
void CFE_TBL_AbortLoad(CFE_TBL_RegistryRec_t *RegRecPtr);
| |