diff --git a/modules/es/fsw/src/cfe_es_api.c b/modules/es/fsw/src/cfe_es_api.c index 3a90e2c8e..6c8ce250a 100644 --- a/modules/es/fsw/src/cfe_es_api.c +++ b/modules/es/fsw/src/cfe_es_api.c @@ -47,7 +47,7 @@ * Function: CFE_ES_GetResetType * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetResetType(uint32 *ResetSubtypePtr) @@ -65,7 +65,7 @@ int32 CFE_ES_GetResetType(uint32 *ResetSubtypePtr) * Function: CFE_ES_ResetCFE * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_ResetCFE(uint32 ResetType) @@ -162,7 +162,7 @@ int32 CFE_ES_ResetCFE(uint32 ResetType) * Function: CFE_ES_RestartApp * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_RestartApp(CFE_ES_AppId_t AppID) @@ -231,7 +231,7 @@ int32 CFE_ES_RestartApp(CFE_ES_AppId_t AppID) * Function: CFE_ES_ReloadApp * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_ReloadApp(CFE_ES_AppId_t AppID, const char *AppFileName) @@ -294,7 +294,7 @@ int32 CFE_ES_ReloadApp(CFE_ES_AppId_t AppID, const char *AppFileName) * Function: CFE_ES_DeleteApp * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_DeleteApp(CFE_ES_AppId_t AppID) @@ -341,7 +341,7 @@ int32 CFE_ES_DeleteApp(CFE_ES_AppId_t AppID) * Function: CFE_ES_ExitApp * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_ExitApp(uint32 ExitStatus) @@ -474,7 +474,7 @@ void CFE_ES_ExitApp(uint32 ExitStatus) * Function: CFE_ES_RunLoop * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_ES_RunLoop(uint32 *RunStatus) @@ -565,7 +565,7 @@ bool CFE_ES_RunLoop(uint32 *RunStatus) * Function: CFE_ES_WaitForSystemState * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_WaitForSystemState(uint32 MinSystemState, uint32 TimeOutMilliseconds) @@ -669,7 +669,7 @@ int32 CFE_ES_WaitForSystemState(uint32 MinSystemState, uint32 TimeOutMillisecond * Function: CFE_ES_WaitForStartupSync * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_WaitForStartupSync(uint32 TimeOutMilliseconds) @@ -682,7 +682,7 @@ void CFE_ES_WaitForStartupSync(uint32 TimeOutMilliseconds) * Function: CFE_ES_GetAppIDByName * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetAppIDByName(CFE_ES_AppId_t *AppIdPtr, const char *AppName) @@ -723,7 +723,7 @@ int32 CFE_ES_GetAppIDByName(CFE_ES_AppId_t *AppIdPtr, const char *AppName) * Function: CFE_ES_GetLibIDByName * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetLibIDByName(CFE_ES_LibId_t *LibIdPtr, const char *LibName) @@ -764,7 +764,7 @@ int32 CFE_ES_GetLibIDByName(CFE_ES_LibId_t *LibIdPtr, const char *LibName) * Function: CFE_ES_GetTaskIDByName * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_Status_t CFE_ES_GetTaskIDByName(CFE_ES_TaskId_t *TaskIdPtr, const char *TaskName) @@ -799,7 +799,7 @@ CFE_Status_t CFE_ES_GetTaskIDByName(CFE_ES_TaskId_t *TaskIdPtr, const char *Task * Function: CFE_ES_GetAppID * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetAppID(CFE_ES_AppId_t *AppIdPtr) @@ -837,7 +837,7 @@ int32 CFE_ES_GetAppID(CFE_ES_AppId_t *AppIdPtr) * Function: CFE_ES_GetTaskID * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetTaskID(CFE_ES_TaskId_t *TaskIdPtr) @@ -871,7 +871,7 @@ int32 CFE_ES_GetTaskID(CFE_ES_TaskId_t *TaskIdPtr) * Function: CFE_ES_GetAppName * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetAppName(char *AppName, CFE_ES_AppId_t AppId, size_t BufferLength) @@ -917,7 +917,7 @@ int32 CFE_ES_GetAppName(char *AppName, CFE_ES_AppId_t AppId, size_t BufferLength * Function: CFE_ES_GetLibName * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetLibName(char *LibName, CFE_ES_LibId_t LibId, size_t BufferLength) @@ -963,7 +963,7 @@ int32 CFE_ES_GetLibName(char *LibName, CFE_ES_LibId_t LibId, size_t BufferLength * Function: CFE_ES_GetTaskName * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetTaskName(char *TaskName, CFE_ES_TaskId_t TaskId, size_t BufferLength) @@ -1000,7 +1000,7 @@ int32 CFE_ES_GetTaskName(char *TaskName, CFE_ES_TaskId_t TaskId, size_t BufferLe * Function: CFE_ES_GetAppInfo * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetAppInfo(CFE_ES_AppInfo_t *AppInfo, CFE_ES_AppId_t AppId) @@ -1097,7 +1097,7 @@ int32 CFE_ES_GetAppInfo(CFE_ES_AppInfo_t *AppInfo, CFE_ES_AppId_t AppId) * Function: CFE_ES_GetLibInfo * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetLibInfo(CFE_ES_AppInfo_t *LibInfo, CFE_ES_LibId_t LibId) @@ -1161,7 +1161,7 @@ int32 CFE_ES_GetLibInfo(CFE_ES_AppInfo_t *LibInfo, CFE_ES_LibId_t LibId) * Function: CFE_ES_GetModuleInfo * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetModuleInfo(CFE_ES_AppInfo_t *ModuleInfo, CFE_ResourceId_t ResourceId) @@ -1194,7 +1194,7 @@ int32 CFE_ES_GetModuleInfo(CFE_ES_AppInfo_t *ModuleInfo, CFE_ResourceId_t Resour * Function: CFE_ES_GetTaskInfo * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetTaskInfo(CFE_ES_TaskInfo_t *TaskInfo, CFE_ES_TaskId_t TaskId) @@ -1270,7 +1270,7 @@ int32 CFE_ES_GetTaskInfo(CFE_ES_TaskInfo_t *TaskInfo, CFE_ES_TaskId_t TaskId) * Function: CFE_ES_CreateChildTask * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_CreateChildTask(CFE_ES_TaskId_t *TaskIdPtr, const char *TaskName, @@ -1368,7 +1368,7 @@ int32 CFE_ES_CreateChildTask(CFE_ES_TaskId_t *TaskIdPtr, const char *TaskName, * Function: CFE_ES_IncrementTaskCounter * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_IncrementTaskCounter(void) @@ -1400,7 +1400,7 @@ void CFE_ES_IncrementTaskCounter(void) * Function: CFE_ES_DeleteChildTask * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_DeleteChildTask(CFE_ES_TaskId_t TaskId) @@ -1517,7 +1517,7 @@ int32 CFE_ES_DeleteChildTask(CFE_ES_TaskId_t TaskId) * Function: CFE_ES_ExitChildTask * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_ExitChildTask(void) @@ -1575,7 +1575,7 @@ void CFE_ES_ExitChildTask(void) * Function: CFE_ES_WriteToSysLog * * Application-scope internal function - * See description in cfe_es_log.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_WriteToSysLog(const char *SpecStringPtr, ...) @@ -1612,7 +1612,7 @@ int32 CFE_ES_WriteToSysLog(const char *SpecStringPtr, ...) * Function: CFE_ES_CalculateCRC * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ uint32 CFE_ES_CalculateCRC(const void *DataPtr, size_t DataLength, uint32 InputCRC, uint32 TypeCRC) @@ -1690,7 +1690,7 @@ uint32 CFE_ES_CalculateCRC(const void *DataPtr, size_t DataLength, uint32 InputC * Function: CFE_ES_RegisterCDS * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_RegisterCDS(CFE_ES_CDSHandle_t *CDSHandlePtr, size_t BlockSize, const char *Name) @@ -1774,7 +1774,7 @@ int32 CFE_ES_RegisterCDS(CFE_ES_CDSHandle_t *CDSHandlePtr, size_t BlockSize, con * Function: CFE_ES_GetCDSBlockIDByName * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_Status_t CFE_ES_GetCDSBlockIDByName(CFE_ES_CDSHandle_t *BlockIdPtr, const char *BlockName) @@ -1816,7 +1816,7 @@ CFE_Status_t CFE_ES_GetCDSBlockIDByName(CFE_ES_CDSHandle_t *BlockIdPtr, const ch * Function: CFE_ES_GetCDSBlockName * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_Status_t CFE_ES_GetCDSBlockName(char *BlockName, CFE_ES_CDSHandle_t BlockId, size_t BufferLength) @@ -1859,7 +1859,7 @@ CFE_Status_t CFE_ES_GetCDSBlockName(char *BlockName, CFE_ES_CDSHandle_t BlockId, * Function: CFE_ES_CopyToCDS * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_CopyToCDS(CFE_ES_CDSHandle_t Handle, void *DataToCopy) @@ -1877,7 +1877,7 @@ int32 CFE_ES_CopyToCDS(CFE_ES_CDSHandle_t Handle, void *DataToCopy) * Function: CFE_ES_RestoreFromCDS * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_RestoreFromCDS(void *RestoreToMemory, CFE_ES_CDSHandle_t Handle) @@ -1895,7 +1895,7 @@ int32 CFE_ES_RestoreFromCDS(void *RestoreToMemory, CFE_ES_CDSHandle_t Handle) * Function: CFE_ES_RegisterGenCounter * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_RegisterGenCounter(CFE_ES_CounterId_t *CounterIdPtr, const char *CounterName) @@ -1960,7 +1960,7 @@ int32 CFE_ES_RegisterGenCounter(CFE_ES_CounterId_t *CounterIdPtr, const char *Co * Function: CFE_ES_DeleteGenCounter * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_DeleteGenCounter(CFE_ES_CounterId_t CounterId) @@ -1989,7 +1989,7 @@ int32 CFE_ES_DeleteGenCounter(CFE_ES_CounterId_t CounterId) * Function: CFE_ES_IncrementGenCounter * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_IncrementGenCounter(CFE_ES_CounterId_t CounterId) @@ -2011,7 +2011,7 @@ int32 CFE_ES_IncrementGenCounter(CFE_ES_CounterId_t CounterId) * Function: CFE_ES_SetGenCount * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_SetGenCount(CFE_ES_CounterId_t CounterId, uint32 Count) @@ -2033,7 +2033,7 @@ int32 CFE_ES_SetGenCount(CFE_ES_CounterId_t CounterId, uint32 Count) * Function: CFE_ES_GetGenCount * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetGenCount(CFE_ES_CounterId_t CounterId, uint32 *Count) @@ -2055,7 +2055,7 @@ int32 CFE_ES_GetGenCount(CFE_ES_CounterId_t CounterId, uint32 *Count) * Function: CFE_ES_GetGenCounterIDByName * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetGenCounterIDByName(CFE_ES_CounterId_t *CounterIdPtr, const char *CounterName) @@ -2099,7 +2099,7 @@ int32 CFE_ES_GetGenCounterIDByName(CFE_ES_CounterId_t *CounterIdPtr, const char * Function: CFE_ES_GetGenCounterName * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_Status_t CFE_ES_GetGenCounterName(char *CounterName, CFE_ES_CounterId_t CounterId, size_t BufferLength) @@ -2138,7 +2138,7 @@ CFE_Status_t CFE_ES_GetGenCounterName(char *CounterName, CFE_ES_CounterId_t Coun * Function: CFE_ES_AppID_ToIndex * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_AppID_ToIndex(CFE_ES_AppId_t AppID, uint32 *Idx) @@ -2152,7 +2152,7 @@ int32 CFE_ES_AppID_ToIndex(CFE_ES_AppId_t AppID, uint32 *Idx) * Function: CFE_ES_LibID_ToIndex * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_LibID_ToIndex(CFE_ES_LibId_t LibId, uint32 *Idx) @@ -2165,7 +2165,7 @@ int32 CFE_ES_LibID_ToIndex(CFE_ES_LibId_t LibId, uint32 *Idx) * Function: CFE_ES_TaskID_ToIndex * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_TaskID_ToIndex(CFE_ES_TaskId_t TaskID, uint32 *Idx) @@ -2194,7 +2194,7 @@ int32 CFE_ES_TaskID_ToIndex(CFE_ES_TaskId_t TaskID, uint32 *Idx) * Function: CFE_ES_CounterID_ToIndex * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_CounterID_ToIndex(CFE_ES_CounterId_t CounterId, uint32 *Idx) @@ -2212,7 +2212,7 @@ int32 CFE_ES_CounterID_ToIndex(CFE_ES_CounterId_t CounterId, uint32 *Idx) * Function: CFE_ES_LockSharedData * * Application-scope internal function - * See description in cfe_es_global.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_LockSharedData(const char *FunctionName, int32 LineNumber) @@ -2239,7 +2239,7 @@ void CFE_ES_LockSharedData(const char *FunctionName, int32 LineNumber) * Function: CFE_ES_UnlockSharedData * * Application-scope internal function - * See description in cfe_es_global.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_UnlockSharedData(const char *FunctionName, int32 LineNumber) @@ -2266,7 +2266,7 @@ void CFE_ES_UnlockSharedData(const char *FunctionName, int32 LineNumber) * Function: CFE_ES_ProcessAsyncEvent * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_ProcessAsyncEvent(void) diff --git a/modules/es/fsw/src/cfe_es_apps.c b/modules/es/fsw/src/cfe_es_apps.c index eaa883413..25e970268 100644 --- a/modules/es/fsw/src/cfe_es_apps.c +++ b/modules/es/fsw/src/cfe_es_apps.c @@ -69,7 +69,7 @@ * Function: CFE_ES_StartApplications * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_StartApplications(uint32 ResetType, const char *StartFilePath) @@ -265,7 +265,7 @@ void CFE_ES_StartApplications(uint32 ResetType, const char *StartFilePath) * Function: CFE_ES_ParseFileEntry * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_ParseFileEntry(const char **TokenList, uint32 NumTokens) @@ -376,7 +376,7 @@ int32 CFE_ES_ParseFileEntry(const char **TokenList, uint32 NumTokens) * Function: CFE_ES_LoadModule * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_LoadModule(CFE_ResourceId_t ParentResourceId, const char *ModuleName, @@ -478,7 +478,7 @@ int32 CFE_ES_LoadModule(CFE_ResourceId_t ParentResourceId, const char *ModuleNam * Function: CFE_ES_GetTaskFunction * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetTaskFunction(CFE_ES_TaskEntryFuncPtr_t *FuncPtr) @@ -534,7 +534,7 @@ int32 CFE_ES_GetTaskFunction(CFE_ES_TaskEntryFuncPtr_t *FuncPtr) * Function: CFE_ES_TaskEntryPoint * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_TaskEntryPoint(void) @@ -564,7 +564,7 @@ void CFE_ES_TaskEntryPoint(void) * Function: CFE_ES_StartAppTask * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_StartAppTask(CFE_ES_TaskId_t *TaskIdPtr, const char *TaskName, CFE_ES_TaskEntryFuncPtr_t EntryFunc, @@ -644,7 +644,7 @@ int32 CFE_ES_StartAppTask(CFE_ES_TaskId_t *TaskIdPtr, const char *TaskName, CFE_ * Function: CFE_ES_AppCreate * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_AppCreate(CFE_ES_AppId_t *ApplicationIdPtr, const char *AppName, const CFE_ES_AppStartParams_t *Params) @@ -809,7 +809,7 @@ int32 CFE_ES_AppCreate(CFE_ES_AppId_t *ApplicationIdPtr, const char *AppName, co * Function: CFE_ES_LoadLibrary * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_LoadLibrary(CFE_ES_LibId_t *LibraryIdPtr, const char *LibName, const CFE_ES_ModuleLoadParams_t *Params) @@ -965,7 +965,7 @@ int32 CFE_ES_LoadLibrary(CFE_ES_LibId_t *LibraryIdPtr, const char *LibName, cons * Function: CFE_ES_RunAppTableScan * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_ES_RunAppTableScan(uint32 ElapsedTime, void *Arg) @@ -1088,7 +1088,7 @@ bool CFE_ES_RunAppTableScan(uint32 ElapsedTime, void *Arg) * Function: CFE_ES_ProcessControlRequest * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_ProcessControlRequest(CFE_ES_AppId_t AppId) @@ -1314,7 +1314,7 @@ void CFE_ES_ProcessControlRequest(CFE_ES_AppId_t AppId) * Function: CFE_ES_CleanUpApp * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_CleanUpApp(CFE_ES_AppId_t AppId) @@ -1660,7 +1660,7 @@ void CFE_ES_CleanupObjectCallback(osal_id_t ObjectId, void *arg) * Function: CFE_ES_CleanupTaskResources * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_CleanupTaskResources(CFE_ES_TaskId_t TaskId) @@ -1727,7 +1727,7 @@ int32 CFE_ES_CleanupTaskResources(CFE_ES_TaskId_t TaskId) * Function: CFE_ES_CopyModuleBasicInfo * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_CopyModuleBasicInfo(const CFE_ES_ModuleLoadParams_t *ParamsPtr, CFE_ES_AppInfo_t *AppInfoPtr) @@ -1744,7 +1744,7 @@ void CFE_ES_CopyModuleBasicInfo(const CFE_ES_ModuleLoadParams_t *ParamsPtr, CFE_ * Function: CFE_ES_CopyModuleStatusInfo * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_CopyModuleStatusInfo(const CFE_ES_ModuleLoadStatus_t *StatusPtr, CFE_ES_AppInfo_t *AppInfoPtr) @@ -1757,7 +1757,7 @@ void CFE_ES_CopyModuleStatusInfo(const CFE_ES_ModuleLoadStatus_t *StatusPtr, CFE * Function: CFE_ES_CopyModuleAddressInfo * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_CopyModuleAddressInfo(osal_id_t ModuleId, CFE_ES_AppInfo_t *AppInfoPtr) diff --git a/modules/es/fsw/src/cfe_es_backgroundtask.c b/modules/es/fsw/src/cfe_es_backgroundtask.c index d1003894c..5909b321f 100644 --- a/modules/es/fsw/src/cfe_es_backgroundtask.c +++ b/modules/es/fsw/src/cfe_es_backgroundtask.c @@ -93,7 +93,7 @@ const CFE_ES_BackgroundJobEntry_t CFE_ES_BACKGROUND_JOB_TABLE[] = { * Function: CFE_ES_BackgroundTask * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_BackgroundTask(void) @@ -167,7 +167,7 @@ void CFE_ES_BackgroundTask(void) * Function: CFE_ES_BackgroundInit * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_BackgroundInit(void) @@ -201,7 +201,7 @@ int32 CFE_ES_BackgroundInit(void) * Function: CFE_ES_BackgroundCleanup * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_BackgroundCleanup(void) @@ -218,7 +218,7 @@ void CFE_ES_BackgroundCleanup(void) * Function: CFE_ES_BackgroundWakeup * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_BackgroundWakeup(void) diff --git a/modules/es/fsw/src/cfe_es_cds.c b/modules/es/fsw/src/cfe_es_cds.c index e6022d79b..5b65bde2f 100644 --- a/modules/es/fsw/src/cfe_es_cds.c +++ b/modules/es/fsw/src/cfe_es_cds.c @@ -49,7 +49,7 @@ * Function: CFE_ES_CDS_EarlyInit * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_CDS_EarlyInit(void) @@ -153,7 +153,7 @@ int32 CFE_ES_CDS_EarlyInit(void) * Function: CFE_ES_CDSHandle_ToIndex * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_CDSHandle_ToIndex(CFE_ES_CDSHandle_t BlockID, uint32 *Idx) @@ -167,7 +167,7 @@ int32 CFE_ES_CDSHandle_ToIndex(CFE_ES_CDSHandle_t BlockID, uint32 *Idx) * Function: CFE_ES_CheckCDSHandleSlotUsed * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_ES_CheckCDSHandleSlotUsed(CFE_ResourceId_t CheckId) @@ -187,7 +187,7 @@ bool CFE_ES_CheckCDSHandleSlotUsed(CFE_ResourceId_t CheckId) * Function: CFE_ES_LocateCDSBlockRecordByID * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_ES_CDS_RegRec_t *CFE_ES_LocateCDSBlockRecordByID(CFE_ES_CDSHandle_t BlockID) @@ -213,7 +213,7 @@ CFE_ES_CDS_RegRec_t *CFE_ES_LocateCDSBlockRecordByID(CFE_ES_CDSHandle_t BlockID) * Function: CFE_ES_CDS_CacheFetch * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_CDS_CacheFetch(CFE_ES_CDS_AccessCache_t *Cache, size_t Offset, size_t Size) @@ -248,7 +248,7 @@ int32 CFE_ES_CDS_CacheFetch(CFE_ES_CDS_AccessCache_t *Cache, size_t Offset, size * Function: CFE_ES_CDS_CacheFlush * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_CDS_CacheFlush(CFE_ES_CDS_AccessCache_t *Cache) @@ -281,7 +281,7 @@ int32 CFE_ES_CDS_CacheFlush(CFE_ES_CDS_AccessCache_t *Cache) * Function: CFE_ES_CDS_CachePreload * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_CDS_CachePreload(CFE_ES_CDS_AccessCache_t *Cache, const void *Source, size_t Offset, size_t Size) @@ -317,7 +317,7 @@ int32 CFE_ES_CDS_CachePreload(CFE_ES_CDS_AccessCache_t *Cache, const void *Sourc * Function: CFE_ES_RegisterCDSEx * * Implemented per public API - * See description in cfe_es_core_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_RegisterCDSEx(CFE_ES_CDSHandle_t *HandlePtr, size_t UserBlockSize, const char *Name, bool CriticalTbl) @@ -477,7 +477,7 @@ int32 CFE_ES_RegisterCDSEx(CFE_ES_CDSHandle_t *HandlePtr, size_t UserBlockSize, * Function: CFE_ES_ValidateCDS * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_ValidateCDS(void) @@ -528,7 +528,7 @@ int32 CFE_ES_ValidateCDS(void) * Function: CFE_ES_ClearCDS * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_ClearCDS(void) @@ -573,7 +573,7 @@ int32 CFE_ES_ClearCDS(void) * Function: CFE_ES_InitCDSSignatures * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_InitCDSSignatures(void) @@ -614,7 +614,7 @@ int32 CFE_ES_InitCDSSignatures(void) * Function: CFE_ES_InitCDSRegistry * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_InitCDSRegistry(void) @@ -648,7 +648,7 @@ int32 CFE_ES_InitCDSRegistry(void) * Function: CFE_ES_UpdateCDSRegistry * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_UpdateCDSRegistry(void) @@ -673,7 +673,7 @@ int32 CFE_ES_UpdateCDSRegistry(void) * Function: CFE_ES_FormCDSName * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_FormCDSName(char *FullCDSName, const char *CDSName, CFE_ES_AppId_t ThisAppId) @@ -696,7 +696,7 @@ void CFE_ES_FormCDSName(char *FullCDSName, const char *CDSName, CFE_ES_AppId_t T * Function: CFE_ES_LockCDS * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_LockCDS(void) @@ -724,7 +724,7 @@ int32 CFE_ES_LockCDS(void) * Function: CFE_ES_UnlockCDS * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_UnlockCDS(void) @@ -752,7 +752,7 @@ int32 CFE_ES_UnlockCDS(void) * Function: CFE_ES_LocateCDSBlockRecordByName * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_ES_CDS_RegRec_t *CFE_ES_LocateCDSBlockRecordByName(const char *CDSName) @@ -793,7 +793,7 @@ CFE_ES_CDS_RegRec_t *CFE_ES_LocateCDSBlockRecordByName(const char *CDSName) * Function: CFE_ES_RebuildCDS * * Application-scope internal function - * See description in cfe_es_cds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_RebuildCDS(void) @@ -842,7 +842,7 @@ int32 CFE_ES_RebuildCDS(void) * Function: CFE_ES_DeleteCDS * * Implemented per public API - * See description in cfe_es_core_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_DeleteCDS(const char *CDSName, bool CalledByTblServices) diff --git a/modules/es/fsw/src/cfe_es_cds_mempool.c b/modules/es/fsw/src/cfe_es_cds_mempool.c index 5b3fe6a1f..180eab452 100644 --- a/modules/es/fsw/src/cfe_es_cds_mempool.c +++ b/modules/es/fsw/src/cfe_es_cds_mempool.c @@ -106,7 +106,7 @@ int32 CFE_ES_CDS_PoolCommit(CFE_ES_GenPoolRecord_t *GenPoolRecPtr, size_t Offset * Function: CFE_ES_CreateCDSPool * * Application-scope internal function - * See description in cfe_es_cds_mempool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_CreateCDSPool(size_t CDSPoolSize, size_t StartOffset) @@ -141,7 +141,7 @@ int32 CFE_ES_CreateCDSPool(size_t CDSPoolSize, size_t StartOffset) * Function: CFE_ES_RebuildCDSPool * * Application-scope internal function - * See description in cfe_es_cds_mempool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_RebuildCDSPool(size_t CDSPoolSize, size_t StartOffset) @@ -175,7 +175,7 @@ int32 CFE_ES_RebuildCDSPool(size_t CDSPoolSize, size_t StartOffset) * Function: CFE_ES_CDSBlockWrite * * Application-scope internal function - * See description in cfe_es_cds_mempool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_CDSBlockWrite(CFE_ES_CDSHandle_t Handle, const void *DataToWrite) @@ -274,7 +274,7 @@ int32 CFE_ES_CDSBlockWrite(CFE_ES_CDSHandle_t Handle, const void *DataToWrite) * Function: CFE_ES_CDSBlockRead * * Application-scope internal function - * See description in cfe_es_cds_mempool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_CDSBlockRead(void *DataRead, CFE_ES_CDSHandle_t Handle) @@ -368,7 +368,7 @@ int32 CFE_ES_CDSBlockRead(void *DataRead, CFE_ES_CDSHandle_t Handle) * Function: CFE_ES_CDSReqdMinSize * * Application-scope internal function - * See description in cfe_es_cds_mempool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ size_t CFE_ES_CDSReqdMinSize(uint32 MaxNumBlocksToSupport) diff --git a/modules/es/fsw/src/cfe_es_erlog.c b/modules/es/fsw/src/cfe_es_erlog.c index ae2ebf602..06328db2a 100644 --- a/modules/es/fsw/src/cfe_es_erlog.c +++ b/modules/es/fsw/src/cfe_es_erlog.c @@ -49,7 +49,7 @@ * Function: CFE_ES_WriteToERLogWithContext * * Application-scope internal function - * See description in cfe_es_log.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_WriteToERLogWithContext(CFE_ES_LogEntryType_Enum_t EntryType, uint32 ResetType, uint32 ResetSubtype, @@ -152,7 +152,7 @@ int32 CFE_ES_WriteToERLogWithContext(CFE_ES_LogEntryType_Enum_t EntryType, uint3 * Function: CFE_ES_WriteToERLog * * Application-scope internal function - * See description in cfe_es_log.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_WriteToERLog(CFE_ES_LogEntryType_Enum_t EntryType, uint32 ResetType, uint32 ResetSubtype, @@ -168,7 +168,7 @@ int32 CFE_ES_WriteToERLog(CFE_ES_LogEntryType_Enum_t EntryType, uint32 ResetType * Function: CFE_ES_BackgroundERLogFileDataGetter * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_ES_BackgroundERLogFileDataGetter(void *Meta, uint32 RecordNum, void **Buffer, size_t *BufSize) @@ -235,7 +235,7 @@ bool CFE_ES_BackgroundERLogFileDataGetter(void *Meta, uint32 RecordNum, void **B * Function: CFE_ES_BackgroundERLogFileEventHandler * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_BackgroundERLogFileEventHandler(void *Meta, CFE_FS_FileWriteEvent_t Event, int32 Status, uint32 RecordNum, @@ -282,7 +282,7 @@ void CFE_ES_BackgroundERLogFileEventHandler(void *Meta, CFE_FS_FileWriteEvent_t * Function: CFE_ES_RunExceptionScan * * Application-scope internal function - * See description in cfe_es_apps.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_ES_RunExceptionScan(uint32 ElapsedTime, void *Arg) diff --git a/modules/es/fsw/src/cfe_es_generic_pool.c b/modules/es/fsw/src/cfe_es_generic_pool.c index 1e6e4a2e4..5d3bf7c12 100644 --- a/modules/es/fsw/src/cfe_es_generic_pool.c +++ b/modules/es/fsw/src/cfe_es_generic_pool.c @@ -240,7 +240,7 @@ int32 CFE_ES_GenPoolCreatePoolBlock(CFE_ES_GenPoolRecord_t *PoolRecPtr, uint16 B * Function: CFE_ES_GenPoolInitialize * * Application-scope internal function - * See description in cfe_es_generic_pool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GenPoolInitialize(CFE_ES_GenPoolRecord_t *PoolRecPtr, size_t StartOffset, size_t PoolSize, @@ -332,7 +332,7 @@ int32 CFE_ES_GenPoolInitialize(CFE_ES_GenPoolRecord_t *PoolRecPtr, size_t StartO * Function: CFE_ES_GenPoolCalcMinSize * * Application-scope internal function - * See description in cfe_es_generic_pool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ size_t CFE_ES_GenPoolCalcMinSize(uint16 NumBlockSizes, const size_t *BlockSizeList, uint32 NumBlocks) @@ -364,7 +364,7 @@ size_t CFE_ES_GenPoolCalcMinSize(uint16 NumBlockSizes, const size_t *BlockSizeLi * Function: CFE_ES_GenPoolGetBlock * * Application-scope internal function - * See description in cfe_es_generic_pool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GenPoolGetBlock(CFE_ES_GenPoolRecord_t *PoolRecPtr, size_t *BlockOffsetPtr, size_t ReqSize) @@ -397,7 +397,7 @@ int32 CFE_ES_GenPoolGetBlock(CFE_ES_GenPoolRecord_t *PoolRecPtr, size_t *BlockOf * Function: CFE_ES_GenPoolGetBlockSize * * Application-scope internal function - * See description in cfe_es_generic_pool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GenPoolGetBlockSize(CFE_ES_GenPoolRecord_t *PoolRecPtr, size_t *BlockSizePtr, size_t BlockOffset) @@ -442,7 +442,7 @@ int32 CFE_ES_GenPoolGetBlockSize(CFE_ES_GenPoolRecord_t *PoolRecPtr, size_t *Blo * Function: CFE_ES_GenPoolPutBlock * * Application-scope internal function - * See description in cfe_es_generic_pool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GenPoolPutBlock(CFE_ES_GenPoolRecord_t *PoolRecPtr, size_t *BlockSizePtr, size_t BlockOffset) @@ -497,7 +497,7 @@ int32 CFE_ES_GenPoolPutBlock(CFE_ES_GenPoolRecord_t *PoolRecPtr, size_t *BlockSi * Function: CFE_ES_GenPoolRebuild * * Application-scope internal function - * See description in cfe_es_generic_pool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GenPoolRebuild(CFE_ES_GenPoolRecord_t *PoolRecPtr) @@ -609,7 +609,7 @@ int32 CFE_ES_GenPoolRebuild(CFE_ES_GenPoolRecord_t *PoolRecPtr) * Function: CFE_ES_GenPoolValidateState * * Application-scope internal function - * See description in cfe_es_generic_pool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_ES_GenPoolValidateState(const CFE_ES_GenPoolRecord_t *PoolRecPtr) @@ -623,7 +623,7 @@ bool CFE_ES_GenPoolValidateState(const CFE_ES_GenPoolRecord_t *PoolRecPtr) * Function: CFE_ES_GenPoolGetUsage * * Application-scope internal function - * See description in cfe_es_generic_pool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_GenPoolGetUsage(CFE_ES_GenPoolRecord_t *PoolRecPtr, CFE_ES_MemOffset_t *FreeSizeBuf, @@ -644,7 +644,7 @@ void CFE_ES_GenPoolGetUsage(CFE_ES_GenPoolRecord_t *PoolRecPtr, CFE_ES_MemOffset * Function: CFE_ES_GenPoolGetCounts * * Application-scope internal function - * See description in cfe_es_generic_pool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_GenPoolGetCounts(CFE_ES_GenPoolRecord_t *PoolRecPtr, uint16 *NumBucketsBuf, uint32 *AllocCountBuf, @@ -669,7 +669,7 @@ void CFE_ES_GenPoolGetCounts(CFE_ES_GenPoolRecord_t *PoolRecPtr, uint16 *NumBuck * Function: CFE_ES_GenPoolGetBucketUsage * * Application-scope internal function - * See description in cfe_es_generic_pool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_GenPoolGetBucketUsage(CFE_ES_GenPoolRecord_t *PoolRecPtr, uint16 BucketId, diff --git a/modules/es/fsw/src/cfe_es_mempool.c b/modules/es/fsw/src/cfe_es_mempool.c index 7985bf061..f81e0de6e 100644 --- a/modules/es/fsw/src/cfe_es_mempool.c +++ b/modules/es/fsw/src/cfe_es_mempool.c @@ -108,7 +108,7 @@ int32 CFE_ES_MemPoolDirectCommit(CFE_ES_GenPoolRecord_t *PoolRecPtr, size_t Offs * Function: CFE_ES_MemPoolID_ToIndex * * Application-scope internal function - * See description in cfe_es_mempool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_MemPoolID_ToIndex(CFE_ES_MemHandle_t PoolID, uint32 *Idx) @@ -122,7 +122,7 @@ int32 CFE_ES_MemPoolID_ToIndex(CFE_ES_MemHandle_t PoolID, uint32 *Idx) * Function: CFE_ES_CheckMemPoolSlotUsed * * Application-scope internal function - * See description in cfe_es_mempool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_ES_CheckMemPoolSlotUsed(CFE_ResourceId_t CheckId) @@ -142,7 +142,7 @@ bool CFE_ES_CheckMemPoolSlotUsed(CFE_ResourceId_t CheckId) * Function: CFE_ES_LocateMemPoolRecordByID * * Application-scope internal function - * See description in cfe_es_mempool.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_ES_MemPoolRecord_t *CFE_ES_LocateMemPoolRecordByID(CFE_ES_MemHandle_t PoolID) @@ -167,7 +167,7 @@ CFE_ES_MemPoolRecord_t *CFE_ES_LocateMemPoolRecordByID(CFE_ES_MemHandle_t PoolID * Function: CFE_ES_PoolCreateNoSem * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_PoolCreateNoSem(CFE_ES_MemHandle_t *PoolID, uint8 *MemPtr, size_t Size) @@ -181,7 +181,7 @@ int32 CFE_ES_PoolCreateNoSem(CFE_ES_MemHandle_t *PoolID, uint8 *MemPtr, size_t S * Function: CFE_ES_PoolCreate * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_PoolCreate(CFE_ES_MemHandle_t *PoolID, uint8 *MemPtr, size_t Size) @@ -195,7 +195,7 @@ int32 CFE_ES_PoolCreate(CFE_ES_MemHandle_t *PoolID, uint8 *MemPtr, size_t Size) * Function: CFE_ES_PoolCreateEx * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_PoolCreateEx(CFE_ES_MemHandle_t *PoolID, uint8 *MemPtr, size_t Size, uint16 NumBlockSizes, @@ -369,7 +369,7 @@ int32 CFE_ES_PoolCreateEx(CFE_ES_MemHandle_t *PoolID, uint8 *MemPtr, size_t Size * Function: CFE_ES_PoolDelete * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_PoolDelete(CFE_ES_MemHandle_t PoolID) @@ -424,7 +424,7 @@ int32 CFE_ES_PoolDelete(CFE_ES_MemHandle_t PoolID) * Function: CFE_ES_GetPoolBuf * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetPoolBuf(CFE_ES_MemPoolBuf_t *BufPtr, CFE_ES_MemHandle_t Handle, size_t Size) @@ -493,7 +493,7 @@ int32 CFE_ES_GetPoolBuf(CFE_ES_MemPoolBuf_t *BufPtr, CFE_ES_MemHandle_t Handle, * Function: CFE_ES_GetPoolBufInfo * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetPoolBufInfo(CFE_ES_MemHandle_t Handle, CFE_ES_MemPoolBuf_t BufPtr) @@ -555,7 +555,7 @@ int32 CFE_ES_GetPoolBufInfo(CFE_ES_MemHandle_t Handle, CFE_ES_MemPoolBuf_t BufPt * Function: CFE_ES_PutPoolBuf * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_PutPoolBuf(CFE_ES_MemHandle_t Handle, CFE_ES_MemPoolBuf_t BufPtr) @@ -638,7 +638,7 @@ int32 CFE_ES_PutPoolBuf(CFE_ES_MemHandle_t Handle, CFE_ES_MemPoolBuf_t BufPtr) * Function: CFE_ES_GetMemPoolStats * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_GetMemPoolStats(CFE_ES_MemPoolStats_t *BufPtr, CFE_ES_MemHandle_t Handle) @@ -710,7 +710,7 @@ int32 CFE_ES_GetMemPoolStats(CFE_ES_MemPoolStats_t *BufPtr, CFE_ES_MemHandle_t H * Function: CFE_ES_ValidateHandle * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_ES_ValidateHandle(CFE_ES_MemHandle_t Handle) diff --git a/modules/es/fsw/src/cfe_es_perf.c b/modules/es/fsw/src/cfe_es_perf.c index 25887db52..1ea940325 100644 --- a/modules/es/fsw/src/cfe_es_perf.c +++ b/modules/es/fsw/src/cfe_es_perf.c @@ -38,7 +38,7 @@ * Function: CFE_ES_SetupPerfVariables * * Application-scope internal function - * See description in cfe_es_start.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_SetupPerfVariables(uint32 ResetType) @@ -100,7 +100,7 @@ void CFE_ES_SetupPerfVariables(uint32 ResetType) * Function: CFE_ES_GetPerfLogDumpRemaining * * Application-scope internal function - * See description in cfe_es_perf.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ uint32 CFE_ES_GetPerfLogDumpRemaining(void) @@ -145,7 +145,7 @@ uint32 CFE_ES_GetPerfLogDumpRemaining(void) * Function: CFE_ES_StartPerfDataCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_StartPerfDataCmd(const CFE_ES_StartPerfDataCmd_t *data) @@ -209,7 +209,7 @@ int32 CFE_ES_StartPerfDataCmd(const CFE_ES_StartPerfDataCmd_t *data) * Function: CFE_ES_StopPerfDataCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_StopPerfDataCmd(const CFE_ES_StopPerfDataCmd_t *data) @@ -275,7 +275,7 @@ int32 CFE_ES_StopPerfDataCmd(const CFE_ES_StopPerfDataCmd_t *data) * Function: CFE_ES_RunPerfLogDump * * Application-scope internal function - * See description in cfe_es_perf.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_ES_RunPerfLogDump(uint32 ElapsedTime, void *Arg) @@ -501,7 +501,7 @@ bool CFE_ES_RunPerfLogDump(uint32 ElapsedTime, void *Arg) * Function: CFE_ES_SetPerfFilterMaskCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_SetPerfFilterMaskCmd(const CFE_ES_SetPerfFilterMaskCmd_t *data) @@ -542,7 +542,7 @@ int32 CFE_ES_SetPerfFilterMaskCmd(const CFE_ES_SetPerfFilterMaskCmd_t *data) * Function: CFE_ES_SetPerfTriggerMaskCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_SetPerfTriggerMaskCmd(const CFE_ES_SetPerfTriggerMaskCmd_t *data) @@ -583,7 +583,7 @@ int32 CFE_ES_SetPerfTriggerMaskCmd(const CFE_ES_SetPerfTriggerMaskCmd_t *data) * Function: CFE_ES_PerfLogAdd * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_PerfLogAdd(uint32 Marker, uint32 EntryExit) diff --git a/modules/es/fsw/src/cfe_es_resource.c b/modules/es/fsw/src/cfe_es_resource.c index 5bccfb8a5..91c1de30f 100644 --- a/modules/es/fsw/src/cfe_es_resource.c +++ b/modules/es/fsw/src/cfe_es_resource.c @@ -44,7 +44,7 @@ * Function: CFE_ES_TaskId_ToOSAL * * Application-scope internal function - * See description in cfe_es_resource.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ osal_id_t CFE_ES_TaskId_ToOSAL(CFE_ES_TaskId_t id) @@ -63,7 +63,7 @@ osal_id_t CFE_ES_TaskId_ToOSAL(CFE_ES_TaskId_t id) * Function: CFE_ES_TaskId_FromOSAL * * Application-scope internal function - * See description in cfe_es_resource.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_ES_TaskId_t CFE_ES_TaskId_FromOSAL(osal_id_t id) @@ -82,7 +82,7 @@ CFE_ES_TaskId_t CFE_ES_TaskId_FromOSAL(osal_id_t id) * Function: CFE_ES_LocateAppRecordByName * * Application-scope internal function - * See description in cfe_es_resource.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_ES_AppRecord_t *CFE_ES_LocateAppRecordByName(const char *Name) @@ -119,7 +119,7 @@ CFE_ES_AppRecord_t *CFE_ES_LocateAppRecordByName(const char *Name) * Function: CFE_ES_LocateLibRecordByName * * Application-scope internal function - * See description in cfe_es_resource.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_ES_LibRecord_t *CFE_ES_LocateLibRecordByName(const char *Name) @@ -156,7 +156,7 @@ CFE_ES_LibRecord_t *CFE_ES_LocateLibRecordByName(const char *Name) * Function: CFE_ES_LocateCounterRecordByName * * Application-scope internal function - * See description in cfe_es_resource.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_ES_GenCounterRecord_t *CFE_ES_LocateCounterRecordByName(const char *Name) @@ -193,7 +193,7 @@ CFE_ES_GenCounterRecord_t *CFE_ES_LocateCounterRecordByName(const char *Name) * Function: CFE_ES_LocateAppRecordByID * * Application-scope internal function - * See description in cfe_es_resource.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_ES_AppRecord_t *CFE_ES_LocateAppRecordByID(CFE_ES_AppId_t AppID) @@ -218,7 +218,7 @@ CFE_ES_AppRecord_t *CFE_ES_LocateAppRecordByID(CFE_ES_AppId_t AppID) * Function: CFE_ES_LocateLibRecordByID * * Application-scope internal function - * See description in cfe_es_resource.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_ES_LibRecord_t *CFE_ES_LocateLibRecordByID(CFE_ES_LibId_t LibID) @@ -243,7 +243,7 @@ CFE_ES_LibRecord_t *CFE_ES_LocateLibRecordByID(CFE_ES_LibId_t LibID) * Function: CFE_ES_LocateTaskRecordByID * * Application-scope internal function - * See description in cfe_es_resource.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_ES_TaskRecord_t *CFE_ES_LocateTaskRecordByID(CFE_ES_TaskId_t TaskID) @@ -268,7 +268,7 @@ CFE_ES_TaskRecord_t *CFE_ES_LocateTaskRecordByID(CFE_ES_TaskId_t TaskID) * Function: CFE_ES_LocateCounterRecordByID * * Application-scope internal function - * See description in cfe_es_resource.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_ES_GenCounterRecord_t *CFE_ES_LocateCounterRecordByID(CFE_ES_CounterId_t CounterID) @@ -293,7 +293,7 @@ CFE_ES_GenCounterRecord_t *CFE_ES_LocateCounterRecordByID(CFE_ES_CounterId_t Cou * Function: CFE_ES_GetTaskRecordByContext * * Application-scope internal function - * See description in cfe_es_resource.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_ES_TaskRecord_t *CFE_ES_GetTaskRecordByContext(void) @@ -326,7 +326,7 @@ CFE_ES_TaskRecord_t *CFE_ES_GetTaskRecordByContext(void) * Function: CFE_ES_GetAppRecordByContext * * Application-scope internal function - * See description in cfe_es_resource.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_ES_AppRecord_t *CFE_ES_GetAppRecordByContext(void) @@ -369,7 +369,7 @@ CFE_ES_AppRecord_t *CFE_ES_GetAppRecordByContext(void) * Function: CFE_ES_CheckCounterIdSlotUsed * * Application-scope internal function - * See description in cfe_es_resource.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_ES_CheckCounterIdSlotUsed(CFE_ResourceId_t CheckId) @@ -389,7 +389,7 @@ bool CFE_ES_CheckCounterIdSlotUsed(CFE_ResourceId_t CheckId) * Function: CFE_ES_CheckAppIdSlotUsed * * Application-scope internal function - * See description in cfe_es_resource.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_ES_CheckAppIdSlotUsed(CFE_ResourceId_t CheckId) @@ -409,7 +409,7 @@ bool CFE_ES_CheckAppIdSlotUsed(CFE_ResourceId_t CheckId) * Function: CFE_ES_CheckLibIdSlotUsed * * Application-scope internal function - * See description in cfe_es_resource.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_ES_CheckLibIdSlotUsed(CFE_ResourceId_t CheckId) diff --git a/modules/es/fsw/src/cfe_es_start.c b/modules/es/fsw/src/cfe_es_start.c index 9a6931dec..ec550bfa1 100644 --- a/modules/es/fsw/src/cfe_es_start.c +++ b/modules/es/fsw/src/cfe_es_start.c @@ -70,7 +70,7 @@ CFE_ES_Global_t CFE_ES_Global; * Function: CFE_ES_Main * * Implemented per public API - * See description in cfe_es.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_Main(uint32 StartType, uint32 StartSubtype, uint32 ModeId, const char *StartFilePath) @@ -242,7 +242,7 @@ void CFE_ES_Main(uint32 StartType, uint32 StartSubtype, uint32 ModeId, const cha * Function: CFE_ES_SetupResetVariables * * Application-scope internal function - * See description in cfe_es_start.h for argument/return detail + * See description in header file for argument/return detail * * SYSLOGGING NOTE: Any logging in here must use CFE_ES_SysLogWrite_Unsync() as the necessary * primitives are not even initialized yet. There is no chance for log contention here. @@ -471,7 +471,7 @@ void CFE_ES_SetupResetVariables(uint32 StartType, uint32 StartSubtype, uint32 Bo * Function: CFE_ES_InitializeFileSystems * * Application-scope internal function - * See description in cfe_es_start.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_InitializeFileSystems(uint32 StartType) @@ -718,7 +718,7 @@ void CFE_ES_InitializeFileSystems(uint32 StartType) * Function: CFE_ES_CreateObjects * * Application-scope internal function - * See description in cfe_es_start.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_CreateObjects(void) diff --git a/modules/es/fsw/src/cfe_es_syslog.c b/modules/es/fsw/src/cfe_es_syslog.c index 7dae9951b..1e639f05b 100644 --- a/modules/es/fsw/src/cfe_es_syslog.c +++ b/modules/es/fsw/src/cfe_es_syslog.c @@ -76,7 +76,7 @@ * Function: CFE_ES_SysLogClear_Unsync * * Application-scope internal function - * See description in cfe_es_log.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_SysLogClear_Unsync(void) @@ -96,7 +96,7 @@ void CFE_ES_SysLogClear_Unsync(void) * Function: CFE_ES_SysLogReadStart_Unsync * * Application-scope internal function - * See description in cfe_es_log.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_SysLogReadStart_Unsync(CFE_ES_SysLogReadBuffer_t *Buffer) @@ -134,7 +134,7 @@ void CFE_ES_SysLogReadStart_Unsync(CFE_ES_SysLogReadBuffer_t *Buffer) * Function: CFE_ES_SysLogAppend_Unsync * * Application-scope internal function - * See description in cfe_es_log.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_SysLogAppend_Unsync(const char *LogString) @@ -258,7 +258,7 @@ int32 CFE_ES_SysLogAppend_Unsync(const char *LogString) * Function: CFE_ES_SysLogWrite_Unsync * * Application-scope internal function - * See description in cfe_es_log.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_SysLogWrite_Unsync(const char *SpecStringPtr, ...) @@ -293,7 +293,7 @@ int32 CFE_ES_SysLogWrite_Unsync(const char *SpecStringPtr, ...) * Function: CFE_ES_SysLogReadData * * Application-scope internal function - * See description in cfe_es_log.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_SysLogReadData(CFE_ES_SysLogReadBuffer_t *Buffer) @@ -343,7 +343,7 @@ void CFE_ES_SysLogReadData(CFE_ES_SysLogReadBuffer_t *Buffer) * Function: CFE_ES_SysLogSetMode * * Application-scope internal function - * See description in cfe_es_log.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_SysLogSetMode(CFE_ES_LogMode_Enum_t Mode) @@ -368,7 +368,7 @@ int32 CFE_ES_SysLogSetMode(CFE_ES_LogMode_Enum_t Mode) * Function: CFE_ES_SysLog_vsnprintf * * Application-scope internal function - * See description in cfe_es_log.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_SysLog_vsnprintf(char *Buffer, size_t BufferSize, const char *SpecStringPtr, va_list ArgPtr) @@ -447,7 +447,7 @@ void CFE_ES_SysLog_vsnprintf(char *Buffer, size_t BufferSize, const char *SpecSt * Function: CFE_ES_SysLog_snprintf * * Application-scope internal function - * See description in cfe_es_log.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_SysLog_snprintf(char *Buffer, size_t BufferSize, const char *SpecStringPtr, ...) @@ -464,7 +464,7 @@ void CFE_ES_SysLog_snprintf(char *Buffer, size_t BufferSize, const char *SpecStr * Function: CFE_ES_SysLogDump * * Application-scope internal function - * See description in cfe_es_log.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_SysLogDump(const char *Filename) diff --git a/modules/es/fsw/src/cfe_es_task.c b/modules/es/fsw/src/cfe_es_task.c index cd9113cf8..4cfdbc6b1 100644 --- a/modules/es/fsw/src/cfe_es_task.c +++ b/modules/es/fsw/src/cfe_es_task.c @@ -68,7 +68,7 @@ CFE_ES_TaskData_t CFE_ES_TaskData; * Function: CFE_ES_TaskMain * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_TaskMain(void) @@ -348,7 +348,7 @@ void CFE_ES_GenerateBuildInfoEvents(void) * Function: CFE_ES_TaskInit * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_TaskInit(void) @@ -517,7 +517,7 @@ int32 CFE_ES_TaskInit(void) * Function: CFE_ES_TaskPipe * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_TaskPipe(CFE_SB_Buffer_t *SBBufPtr) @@ -734,7 +734,7 @@ void CFE_ES_TaskPipe(CFE_SB_Buffer_t *SBBufPtr) * Function: CFE_ES_HousekeepingCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_HousekeepingCmd(const CFE_MSG_CommandHeader_t *data) @@ -848,7 +848,7 @@ int32 CFE_ES_HousekeepingCmd(const CFE_MSG_CommandHeader_t *data) * Function: CFE_ES_NoopCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_NoopCmd(const CFE_ES_NoopCmd_t *Cmd) @@ -877,7 +877,7 @@ int32 CFE_ES_NoopCmd(const CFE_ES_NoopCmd_t *Cmd) * Function: CFE_ES_ResetCountersCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_ResetCountersCmd(const CFE_ES_ResetCountersCmd_t *data) @@ -898,7 +898,7 @@ int32 CFE_ES_ResetCountersCmd(const CFE_ES_ResetCountersCmd_t *data) * Function: CFE_ES_RestartCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_RestartCmd(const CFE_ES_RestartCmd_t *data) @@ -927,7 +927,7 @@ int32 CFE_ES_RestartCmd(const CFE_ES_RestartCmd_t *data) * Function: CFE_ES_StartAppCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_StartAppCmd(const CFE_ES_StartAppCmd_t *data) @@ -1032,7 +1032,7 @@ int32 CFE_ES_StartAppCmd(const CFE_ES_StartAppCmd_t *data) * Function: CFE_ES_StopAppCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_StopAppCmd(const CFE_ES_StopAppCmd_t *data) @@ -1083,7 +1083,7 @@ int32 CFE_ES_StopAppCmd(const CFE_ES_StopAppCmd_t *data) * Function: CFE_ES_RestartAppCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_RestartAppCmd(const CFE_ES_RestartAppCmd_t *data) @@ -1133,7 +1133,7 @@ int32 CFE_ES_RestartAppCmd(const CFE_ES_RestartAppCmd_t *data) * Function: CFE_ES_ReloadAppCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_ReloadAppCmd(const CFE_ES_ReloadAppCmd_t *data) @@ -1192,7 +1192,7 @@ int32 CFE_ES_ReloadAppCmd(const CFE_ES_ReloadAppCmd_t *data) * Function: CFE_ES_QueryOneCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_QueryOneCmd(const CFE_ES_QueryOneCmd_t *data) @@ -1259,7 +1259,7 @@ int32 CFE_ES_QueryOneCmd(const CFE_ES_QueryOneCmd_t *data) * Function: CFE_ES_QueryAllCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_QueryAllCmd(const CFE_ES_QueryAllCmd_t *data) @@ -1420,7 +1420,7 @@ int32 CFE_ES_QueryAllCmd(const CFE_ES_QueryAllCmd_t *data) * Function: CFE_ES_QueryAllTasksCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_QueryAllTasksCmd(const CFE_ES_QueryAllTasksCmd_t *data) @@ -1572,7 +1572,7 @@ int32 CFE_ES_QueryAllTasksCmd(const CFE_ES_QueryAllTasksCmd_t *data) * Function: CFE_ES_ClearSysLogCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_ClearSysLogCmd(const CFE_ES_ClearSysLogCmd_t *data) @@ -1599,7 +1599,7 @@ int32 CFE_ES_ClearSysLogCmd(const CFE_ES_ClearSysLogCmd_t *data) * Function: CFE_ES_OverWriteSysLogCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_OverWriteSysLogCmd(const CFE_ES_OverWriteSysLogCmd_t *data) @@ -1632,7 +1632,7 @@ int32 CFE_ES_OverWriteSysLogCmd(const CFE_ES_OverWriteSysLogCmd_t *data) * Function: CFE_ES_WriteSysLogCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_WriteSysLogCmd(const CFE_ES_WriteSysLogCmd_t *data) @@ -1679,7 +1679,7 @@ int32 CFE_ES_WriteSysLogCmd(const CFE_ES_WriteSysLogCmd_t *data) * Function: CFE_ES_ClearERLogCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_ClearERLogCmd(const CFE_ES_ClearERLogCmd_t *data) @@ -1715,7 +1715,7 @@ int32 CFE_ES_ClearERLogCmd(const CFE_ES_ClearERLogCmd_t *data) * Function: CFE_ES_WriteERLogCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_WriteERLogCmd(const CFE_ES_WriteERLogCmd_t *data) @@ -1792,7 +1792,7 @@ int32 CFE_ES_WriteERLogCmd(const CFE_ES_WriteERLogCmd_t *data) * Function: CFE_ES_VerifyCmdLength * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_ES_VerifyCmdLength(CFE_MSG_Message_t *MsgPtr, size_t ExpectedLength) @@ -1828,7 +1828,7 @@ bool CFE_ES_VerifyCmdLength(CFE_MSG_Message_t *MsgPtr, size_t ExpectedLength) * Function: CFE_ES_ResetPRCountCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_ResetPRCountCmd(const CFE_ES_ResetPRCountCmd_t *data) @@ -1853,7 +1853,7 @@ int32 CFE_ES_ResetPRCountCmd(const CFE_ES_ResetPRCountCmd_t *data) * Function: CFE_ES_SetMaxPRCountCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_SetMaxPRCountCmd(const CFE_ES_SetMaxPRCountCmd_t *data) @@ -1881,7 +1881,7 @@ int32 CFE_ES_SetMaxPRCountCmd(const CFE_ES_SetMaxPRCountCmd_t *data) * Function: CFE_ES_DeleteCDSCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_DeleteCDSCmd(const CFE_ES_DeleteCDSCmd_t *data) @@ -1939,7 +1939,7 @@ int32 CFE_ES_DeleteCDSCmd(const CFE_ES_DeleteCDSCmd_t *data) * Function: CFE_ES_SendMemPoolStatsCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_SendMemPoolStatsCmd(const CFE_ES_SendMemPoolStatsCmd_t *data) @@ -1989,7 +1989,7 @@ int32 CFE_ES_SendMemPoolStatsCmd(const CFE_ES_SendMemPoolStatsCmd_t *data) * Function: CFE_ES_DumpCDSRegistryCmd * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ES_DumpCDSRegistryCmd(const CFE_ES_DumpCDSRegistryCmd_t *data) @@ -2116,7 +2116,7 @@ int32 CFE_ES_DumpCDSRegistryCmd(const CFE_ES_DumpCDSRegistryCmd_t *data) * Function: CFE_ES_FileWriteByteCntErr * * Application-scope internal function - * See description in cfe_es_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_ES_FileWriteByteCntErr(const char *Filename, size_t Requested, int32 Status) diff --git a/modules/evs/fsw/src/cfe_evs.c b/modules/evs/fsw/src/cfe_evs.c index d92e5fdc4..62513f4ee 100644 --- a/modules/evs/fsw/src/cfe_evs.c +++ b/modules/evs/fsw/src/cfe_evs.c @@ -40,7 +40,7 @@ * Function: CFE_EVS_Register * * Implemented per public API - * See description in cfe_evs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_Register(const void *Filters, uint16 NumEventFilters, uint16 FilterScheme) @@ -118,7 +118,7 @@ int32 CFE_EVS_Register(const void *Filters, uint16 NumEventFilters, uint16 Filte * Function: CFE_EVS_Unregister * * Implemented per public API - * See description in cfe_evs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_Unregister(void) @@ -142,7 +142,7 @@ int32 CFE_EVS_Unregister(void) * Function: CFE_EVS_SendEvent * * Implemented per public API - * See description in cfe_evs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_SendEvent(uint16 EventID, uint16 EventType, const char *Spec, ...) @@ -187,7 +187,7 @@ int32 CFE_EVS_SendEvent(uint16 EventID, uint16 EventType, const char *Spec, ...) * Function: CFE_EVS_SendEventWithAppID * * Implemented per public API - * See description in cfe_evs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_SendEventWithAppID(uint16 EventID, uint16 EventType, CFE_ES_AppId_t AppID, const char *Spec, ...) @@ -231,7 +231,7 @@ int32 CFE_EVS_SendEventWithAppID(uint16 EventID, uint16 EventType, CFE_ES_AppId_ * Function: CFE_EVS_SendTimedEvent * * Implemented per public API - * See description in cfe_evs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_SendTimedEvent(CFE_TIME_SysTime_t Time, uint16 EventID, uint16 EventType, const char *Spec, ...) @@ -272,7 +272,7 @@ int32 CFE_EVS_SendTimedEvent(CFE_TIME_SysTime_t Time, uint16 EventID, uint16 Eve * Function: CFE_EVS_ResetFilter * * Implemented per public API - * See description in cfe_evs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_ResetFilter(int16 EventID) @@ -313,7 +313,7 @@ int32 CFE_EVS_ResetFilter(int16 EventID) * Function: CFE_EVS_ResetAllFilters * * Implemented per public API - * See description in cfe_evs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_ResetAllFilters(void) diff --git a/modules/evs/fsw/src/cfe_evs_log.c b/modules/evs/fsw/src/cfe_evs_log.c index 66a858fce..9ae504ed3 100644 --- a/modules/evs/fsw/src/cfe_evs_log.c +++ b/modules/evs/fsw/src/cfe_evs_log.c @@ -38,7 +38,7 @@ * Function: EVS_AddLog * * Application-scope internal function - * See description in cfe_evs_log.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void EVS_AddLog(CFE_EVS_LongEventTlm_t *EVS_PktPtr) @@ -95,7 +95,7 @@ void EVS_AddLog(CFE_EVS_LongEventTlm_t *EVS_PktPtr) * Function: EVS_ClearLog * * Application-scope internal function - * See description in cfe_evs_log.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void EVS_ClearLog(void) @@ -122,7 +122,7 @@ void EVS_ClearLog(void) * Function: CFE_EVS_WriteLogDataFileCmd * * Application-scope internal function - * See description in cfe_evs_log.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_WriteLogDataFileCmd(const CFE_EVS_WriteLogDataFileCmd_t *data) @@ -239,7 +239,7 @@ int32 CFE_EVS_WriteLogDataFileCmd(const CFE_EVS_WriteLogDataFileCmd_t *data) * Function: CFE_EVS_SetLogModeCmd * * Application-scope internal function - * See description in cfe_evs_log.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_SetLogModeCmd(const CFE_EVS_SetLogModeCmd_t *data) diff --git a/modules/evs/fsw/src/cfe_evs_task.c b/modules/evs/fsw/src/cfe_evs_task.c index d56a00a63..4bef19928 100644 --- a/modules/evs/fsw/src/cfe_evs_task.c +++ b/modules/evs/fsw/src/cfe_evs_task.c @@ -56,7 +56,7 @@ bool CFE_EVS_VerifyCmdLength(CFE_MSG_Message_t *MsgPtr, size_t ExpectedLength); * Function: CFE_EVS_EarlyInit * * Implemented per public API - * See description in cfe_evs_core_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_EarlyInit(void) @@ -168,7 +168,7 @@ int32 CFE_EVS_EarlyInit(void) * Function: CFE_EVS_CleanUpApp * * Implemented per public API - * See description in cfe_evs_core_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_CleanUpApp(CFE_ES_AppId_t AppID) @@ -196,7 +196,7 @@ int32 CFE_EVS_CleanUpApp(CFE_ES_AppId_t AppID) * Function: CFE_EVS_TaskMain * * Implemented per public API - * See description in cfe_evs_core_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_EVS_TaskMain(void) @@ -258,7 +258,7 @@ void CFE_EVS_TaskMain(void) * Function: CFE_EVS_TaskInit * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_TaskInit(void) @@ -317,7 +317,7 @@ int32 CFE_EVS_TaskInit(void) * Function: CFE_EVS_ProcessCommandPacket * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_EVS_ProcessCommandPacket(CFE_SB_Buffer_t *SBBufPtr) @@ -603,7 +603,7 @@ bool CFE_EVS_VerifyCmdLength(CFE_MSG_Message_t *MsgPtr, size_t ExpectedLength) * Function: CFE_EVS_NoopCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_NoopCmd(const CFE_EVS_NoopCmd_t *data) @@ -617,7 +617,7 @@ int32 CFE_EVS_NoopCmd(const CFE_EVS_NoopCmd_t *data) * Function: CFE_EVS_ClearLogCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_ClearLogCmd(const CFE_EVS_ClearLogCmd_t *data) @@ -631,7 +631,7 @@ int32 CFE_EVS_ClearLogCmd(const CFE_EVS_ClearLogCmd_t *data) * Function: CFE_EVS_ReportHousekeepingCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_ReportHousekeepingCmd(const CFE_MSG_CommandHeader_t *data) @@ -681,7 +681,7 @@ int32 CFE_EVS_ReportHousekeepingCmd(const CFE_MSG_CommandHeader_t *data) * Function: CFE_EVS_ResetCountersCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_ResetCountersCmd(const CFE_EVS_ResetCountersCmd_t *data) @@ -707,7 +707,7 @@ int32 CFE_EVS_ResetCountersCmd(const CFE_EVS_ResetCountersCmd_t *data) * Function: CFE_EVS_SetFilterCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_SetFilterCmd(const CFE_EVS_SetFilterCmd_t *data) @@ -775,7 +775,7 @@ int32 CFE_EVS_SetFilterCmd(const CFE_EVS_SetFilterCmd_t *data) * Function: CFE_EVS_EnablePortsCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_EnablePortsCmd(const CFE_EVS_EnablePortsCmd_t *data) @@ -825,7 +825,7 @@ int32 CFE_EVS_EnablePortsCmd(const CFE_EVS_EnablePortsCmd_t *data) * Function: CFE_EVS_DisablePortsCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_DisablePortsCmd(const CFE_EVS_DisablePortsCmd_t *data) @@ -876,7 +876,7 @@ int32 CFE_EVS_DisablePortsCmd(const CFE_EVS_DisablePortsCmd_t *data) * Function: CFE_EVS_EnableEventTypeCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_EnableEventTypeCmd(const CFE_EVS_EnableEventTypeCmd_t *data) @@ -922,7 +922,7 @@ int32 CFE_EVS_EnableEventTypeCmd(const CFE_EVS_EnableEventTypeCmd_t *data) * Function: CFE_EVS_DisableEventTypeCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_DisableEventTypeCmd(const CFE_EVS_DisableEventTypeCmd_t *data) @@ -969,7 +969,7 @@ int32 CFE_EVS_DisableEventTypeCmd(const CFE_EVS_DisableEventTypeCmd_t *data) * Function: CFE_EVS_SetEventFormatModeCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_SetEventFormatModeCmd(const CFE_EVS_SetEventFormatModeCmd_t *data) @@ -1001,7 +1001,7 @@ int32 CFE_EVS_SetEventFormatModeCmd(const CFE_EVS_SetEventFormatModeCmd_t *data) * Function: CFE_EVS_EnableAppEventTypeCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_EnableAppEventTypeCmd(const CFE_EVS_EnableAppEventTypeCmd_t *data) @@ -1069,7 +1069,7 @@ int32 CFE_EVS_EnableAppEventTypeCmd(const CFE_EVS_EnableAppEventTypeCmd_t *data) * Function: CFE_EVS_DisableAppEventTypeCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_DisableAppEventTypeCmd(const CFE_EVS_DisableAppEventTypeCmd_t *data) @@ -1137,7 +1137,7 @@ int32 CFE_EVS_DisableAppEventTypeCmd(const CFE_EVS_DisableAppEventTypeCmd_t *dat * Function: CFE_EVS_EnableAppEventsCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_EnableAppEventsCmd(const CFE_EVS_EnableAppEventsCmd_t *data) @@ -1189,7 +1189,7 @@ int32 CFE_EVS_EnableAppEventsCmd(const CFE_EVS_EnableAppEventsCmd_t *data) * Function: CFE_EVS_DisableAppEventsCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_DisableAppEventsCmd(const CFE_EVS_DisableAppEventsCmd_t *data) @@ -1241,7 +1241,7 @@ int32 CFE_EVS_DisableAppEventsCmd(const CFE_EVS_DisableAppEventsCmd_t *data) * Function: CFE_EVS_ResetAppCounterCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_ResetAppCounterCmd(const CFE_EVS_ResetAppCounterCmd_t *data) @@ -1293,7 +1293,7 @@ int32 CFE_EVS_ResetAppCounterCmd(const CFE_EVS_ResetAppCounterCmd_t *data) * Function: CFE_EVS_ResetFilterCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_ResetFilterCmd(const CFE_EVS_ResetFilterCmd_t *data) @@ -1360,7 +1360,7 @@ int32 CFE_EVS_ResetFilterCmd(const CFE_EVS_ResetFilterCmd_t *data) * Function: CFE_EVS_ResetAllFiltersCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_ResetAllFiltersCmd(const CFE_EVS_ResetAllFiltersCmd_t *data) @@ -1416,7 +1416,7 @@ int32 CFE_EVS_ResetAllFiltersCmd(const CFE_EVS_ResetAllFiltersCmd_t *data) * Function: CFE_EVS_AddEventFilterCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_AddEventFilterCmd(const CFE_EVS_AddEventFilterCmd_t *data) @@ -1503,7 +1503,7 @@ int32 CFE_EVS_AddEventFilterCmd(const CFE_EVS_AddEventFilterCmd_t *data) * Function: CFE_EVS_DeleteEventFilterCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_DeleteEventFilterCmd(const CFE_EVS_DeleteEventFilterCmd_t *data) @@ -1572,7 +1572,7 @@ int32 CFE_EVS_DeleteEventFilterCmd(const CFE_EVS_DeleteEventFilterCmd_t *data) * Function: CFE_EVS_WriteAppDataFileCmd * * Application-scope internal function - * See description in cfe_evs_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_EVS_WriteAppDataFileCmd(const CFE_EVS_WriteAppDataFileCmd_t *data) diff --git a/modules/evs/fsw/src/cfe_evs_utils.c b/modules/evs/fsw/src/cfe_evs_utils.c index b465dd2c6..f5fd7318e 100644 --- a/modules/evs/fsw/src/cfe_evs_utils.c +++ b/modules/evs/fsw/src/cfe_evs_utils.c @@ -48,7 +48,7 @@ void EVS_OutputPort4(char *Message); * Function: EVS_GetAppDataByID * * Application-scope internal function - * See description in cfe_evs_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ EVS_AppData_t *EVS_GetAppDataByID(CFE_ES_AppId_t AppID) @@ -73,7 +73,7 @@ EVS_AppData_t *EVS_GetAppDataByID(CFE_ES_AppId_t AppID) * Function: EVS_GetCurrentContext * * Application-scope internal function - * See description in cfe_evs_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 EVS_GetCurrentContext(EVS_AppData_t **AppDataOut, CFE_ES_AppId_t *AppIDOut) @@ -116,7 +116,7 @@ int32 EVS_GetCurrentContext(EVS_AppData_t **AppDataOut, CFE_ES_AppId_t *AppIDOut * Function: EVS_GetApplicationInfo * * Application-scope internal function - * See description in cfe_evs_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 EVS_GetApplicationInfo(EVS_AppData_t **AppDataOut, const char *pAppName) @@ -159,7 +159,7 @@ int32 EVS_GetApplicationInfo(EVS_AppData_t **AppDataOut, const char *pAppName) * Function: EVS_NotRegistered * * Application-scope internal function - * See description in cfe_evs_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 EVS_NotRegistered(EVS_AppData_t *AppDataPtr, CFE_ES_AppId_t CallerID) @@ -194,7 +194,7 @@ int32 EVS_NotRegistered(EVS_AppData_t *AppDataPtr, CFE_ES_AppId_t CallerID) * Function: EVS_IsFiltered * * Application-scope internal function - * See description in cfe_evs_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool EVS_IsFiltered(EVS_AppData_t *AppDataPtr, uint16 EventID, uint16 EventType) @@ -294,7 +294,7 @@ bool EVS_IsFiltered(EVS_AppData_t *AppDataPtr, uint16 EventID, uint16 EventType) * Function: EVS_FindEventID * * Application-scope internal function - * See description in cfe_evs_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ EVS_BinFilter_t *EVS_FindEventID(int16 EventID, EVS_BinFilter_t *FilterArray) @@ -317,7 +317,7 @@ EVS_BinFilter_t *EVS_FindEventID(int16 EventID, EVS_BinFilter_t *FilterArray) * Function: EVS_EnableTypes * * Application-scope internal function - * See description in cfe_evs_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void EVS_EnableTypes(EVS_AppData_t *AppDataPtr, uint8 BitMask) @@ -333,7 +333,7 @@ void EVS_EnableTypes(EVS_AppData_t *AppDataPtr, uint8 BitMask) * Function: EVS_DisableTypes * * Application-scope internal function - * See description in cfe_evs_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void EVS_DisableTypes(EVS_AppData_t *AppDataPtr, uint8 BitMask) @@ -349,7 +349,7 @@ void EVS_DisableTypes(EVS_AppData_t *AppDataPtr, uint8 BitMask) * Function: EVS_GenerateEventTelemetry * * Application-scope internal function - * See description in cfe_evs_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void EVS_GenerateEventTelemetry(EVS_AppData_t *AppDataPtr, uint16 EventID, uint16 EventType, @@ -539,7 +539,7 @@ void EVS_OutputPort4(char *Message) * Function: EVS_SendEvent * * Application-scope internal function - * See description in cfe_evs_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 EVS_SendEvent(uint16 EventID, uint16 EventType, const char *Spec, ...) diff --git a/modules/fs/fsw/src/cfe_fs_api.c b/modules/fs/fsw/src/cfe_fs_api.c index 2175a74f4..a63262fbb 100644 --- a/modules/fs/fsw/src/cfe_fs_api.c +++ b/modules/fs/fsw/src/cfe_fs_api.c @@ -52,7 +52,7 @@ const char CFE_FS_DEFAULT_LOG_FILE_EXTENSION[] = ".log"; * Function: CFE_FS_GetDefaultMountPoint * * Implemented per public API - * See description in cfe_fs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ const char *CFE_FS_GetDefaultMountPoint(CFE_FS_FileCategory_t FileCategory) @@ -85,7 +85,7 @@ const char *CFE_FS_GetDefaultMountPoint(CFE_FS_FileCategory_t FileCategory) * Function: CFE_FS_GetDefaultExtension * * Implemented per public API - * See description in cfe_fs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ const char *CFE_FS_GetDefaultExtension(CFE_FS_FileCategory_t FileCategory) @@ -124,7 +124,7 @@ const char *CFE_FS_GetDefaultExtension(CFE_FS_FileCategory_t FileCategory) * Function: CFE_FS_ReadHeader * * Implemented per public API - * See description in cfe_fs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_FS_ReadHeader(CFE_FS_Header_t *Hdr, osal_id_t FileDes) @@ -166,7 +166,7 @@ int32 CFE_FS_ReadHeader(CFE_FS_Header_t *Hdr, osal_id_t FileDes) * Function: CFE_FS_InitHeader * * Implemented per public API - * See description in cfe_fs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_FS_InitHeader(CFE_FS_Header_t *Hdr, const char *Description, uint32 SubType) @@ -188,7 +188,7 @@ void CFE_FS_InitHeader(CFE_FS_Header_t *Hdr, const char *Description, uint32 Sub * Function: CFE_FS_WriteHeader * * Implemented per public API - * See description in cfe_fs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_FS_WriteHeader(osal_id_t FileDes, CFE_FS_Header_t *Hdr) @@ -266,7 +266,7 @@ int32 CFE_FS_WriteHeader(osal_id_t FileDes, CFE_FS_Header_t *Hdr) * Function: CFE_FS_SetTimestamp * * Implemented per public API - * See description in cfe_fs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_FS_SetTimestamp(osal_id_t FileDes, CFE_TIME_SysTime_t NewTimestamp) @@ -327,7 +327,7 @@ int32 CFE_FS_SetTimestamp(osal_id_t FileDes, CFE_TIME_SysTime_t NewTimestamp) * Function: CFE_FS_ByteSwapCFEHeader * * Application-scope internal function - * See description in cfe_fs_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_FS_ByteSwapCFEHeader(CFE_FS_Header_t *Hdr) @@ -347,7 +347,7 @@ void CFE_FS_ByteSwapCFEHeader(CFE_FS_Header_t *Hdr) * Function: CFE_FS_ByteSwapUint32 * * Application-scope internal function - * See description in cfe_fs_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_FS_ByteSwapUint32(uint32 *Uint32ToSwapPtr) @@ -367,7 +367,7 @@ void CFE_FS_ByteSwapUint32(uint32 *Uint32ToSwapPtr) * Function: CFE_FS_ParseInputFileNameEx * * Implemented per public API - * See description in cfe_fs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_FS_ParseInputFileNameEx(char *OutputBuffer, const char *InputBuffer, size_t OutputBufSize, @@ -582,7 +582,7 @@ int32 CFE_FS_ParseInputFileNameEx(char *OutputBuffer, const char *InputBuffer, s * Function: CFE_FS_ParseInputFileName * * Implemented per public API - * See description in cfe_fs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_FS_ParseInputFileName(char *OutputBuffer, const char *InputName, size_t OutputBufSize, @@ -598,7 +598,7 @@ int32 CFE_FS_ParseInputFileName(char *OutputBuffer, const char *InputName, size_ * Function: CFE_FS_ExtractFilenameFromPath * * Implemented per public API - * See description in cfe_fs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_FS_ExtractFilenameFromPath(const char *OriginalPath, char *FileNameOnly) @@ -678,7 +678,7 @@ int32 CFE_FS_ExtractFilenameFromPath(const char *OriginalPath, char *FileNameOnl * Function: CFE_FS_RunBackgroundFileDump * * Implemented per public API - * See description in cfe_fs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_FS_RunBackgroundFileDump(uint32 ElapsedTime, void *Arg) @@ -836,7 +836,7 @@ bool CFE_FS_RunBackgroundFileDump(uint32 ElapsedTime, void *Arg) * Function: CFE_FS_BackgroundFileDumpRequest * * Implemented per public API - * See description in cfe_fs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_FS_BackgroundFileDumpRequest(CFE_FS_FileWriteMetaData_t *Meta) @@ -924,7 +924,7 @@ int32 CFE_FS_BackgroundFileDumpRequest(CFE_FS_FileWriteMetaData_t *Meta) * Function: CFE_FS_BackgroundFileDumpIsPending * * Implemented per public API - * See description in cfe_fs.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_FS_BackgroundFileDumpIsPending(const CFE_FS_FileWriteMetaData_t *Meta) diff --git a/modules/fs/fsw/src/cfe_fs_priv.c b/modules/fs/fsw/src/cfe_fs_priv.c index 1e8a76dff..bd6d13a3a 100644 --- a/modules/fs/fsw/src/cfe_fs_priv.c +++ b/modules/fs/fsw/src/cfe_fs_priv.c @@ -47,7 +47,7 @@ CFE_FS_Global_t CFE_FS_Global; * Function: CFE_FS_EarlyInit * * Implemented per public API - * See description in cfe_fs_core_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_FS_EarlyInit(void) @@ -71,7 +71,7 @@ int32 CFE_FS_EarlyInit(void) * Function: CFE_FS_LockSharedData * * Application-scope internal function - * See description in cfe_fs_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_FS_LockSharedData(const char *FunctionName) @@ -97,7 +97,7 @@ void CFE_FS_LockSharedData(const char *FunctionName) * Function: CFE_FS_UnlockSharedData * * Application-scope internal function - * See description in cfe_fs_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_FS_UnlockSharedData(const char *FunctionName) diff --git a/modules/msg/fsw/src/cfe_msg_ccsdsext.c b/modules/msg/fsw/src/cfe_msg_ccsdsext.c index 4dd72188f..b7794d977 100644 --- a/modules/msg/fsw/src/cfe_msg_ccsdsext.c +++ b/modules/msg/fsw/src/cfe_msg_ccsdsext.c @@ -39,7 +39,7 @@ * Function: CFE_MSG_SetDefaultCCSDSExt * * Application-scope internal function - * See description in cfe_msg_defaults.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_MSG_SetDefaultCCSDSExt(CFE_MSG_Message_t *MsgPtr) @@ -63,7 +63,7 @@ void CFE_MSG_SetDefaultCCSDSExt(CFE_MSG_Message_t *MsgPtr) * Function: CFE_MSG_GetEDSVersion * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetEDSVersion(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_EDSVersion_t *Version) @@ -85,7 +85,7 @@ int32 CFE_MSG_GetEDSVersion(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_EDSVersion_ * Function: CFE_MSG_SetEDSVersion * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_SetEDSVersion(CFE_MSG_Message_t *MsgPtr, CFE_MSG_EDSVersion_t Version) @@ -105,7 +105,7 @@ int32 CFE_MSG_SetEDSVersion(CFE_MSG_Message_t *MsgPtr, CFE_MSG_EDSVersion_t Vers * Function: CFE_MSG_GetEndian * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetEndian(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_Endian_t *Endian) @@ -133,7 +133,7 @@ int32 CFE_MSG_GetEndian(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_Endian_t *Endia * Function: CFE_MSG_SetEndian * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_SetEndian(CFE_MSG_Message_t *MsgPtr, CFE_MSG_Endian_t Endian) @@ -166,7 +166,7 @@ int32 CFE_MSG_SetEndian(CFE_MSG_Message_t *MsgPtr, CFE_MSG_Endian_t Endian) * Function: CFE_MSG_GetPlaybackFlag * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetPlaybackFlag(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_PlaybackFlag_t *PlayFlag) @@ -194,7 +194,7 @@ int32 CFE_MSG_GetPlaybackFlag(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_PlaybackF * Function: CFE_MSG_SetPlaybackFlag * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_SetPlaybackFlag(CFE_MSG_Message_t *MsgPtr, CFE_MSG_PlaybackFlag_t PlayFlag) @@ -227,7 +227,7 @@ int32 CFE_MSG_SetPlaybackFlag(CFE_MSG_Message_t *MsgPtr, CFE_MSG_PlaybackFlag_t * Function: CFE_MSG_GetSubsystem * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetSubsystem(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_Subsystem_t *Subsystem) @@ -248,7 +248,7 @@ int32 CFE_MSG_GetSubsystem(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_Subsystem_t * Function: CFE_MSG_SetSubsystem * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_SetSubsystem(CFE_MSG_Message_t *MsgPtr, CFE_MSG_Subsystem_t Subsystem) @@ -268,7 +268,7 @@ int32 CFE_MSG_SetSubsystem(CFE_MSG_Message_t *MsgPtr, CFE_MSG_Subsystem_t Subsys * Function: CFE_MSG_GetSystem * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetSystem(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_System_t *System) @@ -289,7 +289,7 @@ int32 CFE_MSG_GetSystem(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_System_t *Syste * Function: CFE_MSG_SetSystem * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_SetSystem(CFE_MSG_Message_t *MsgPtr, CFE_MSG_System_t System) diff --git a/modules/msg/fsw/src/cfe_msg_ccsdspri.c b/modules/msg/fsw/src/cfe_msg_ccsdspri.c index 25d7a73a1..748761350 100644 --- a/modules/msg/fsw/src/cfe_msg_ccsdspri.c +++ b/modules/msg/fsw/src/cfe_msg_ccsdspri.c @@ -45,7 +45,7 @@ * Function: CFE_MSG_SetDefaultCCSDSPri * * Application-scope internal function - * See description in cfe_msg_defaults.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_MSG_SetDefaultCCSDSPri(CFE_MSG_Message_t *MsgPtr) @@ -69,7 +69,7 @@ void CFE_MSG_SetDefaultCCSDSPri(CFE_MSG_Message_t *MsgPtr) * Function: CFE_MSG_GetHeaderVersion * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetHeaderVersion(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_HeaderVersion_t *Version) @@ -91,7 +91,7 @@ int32 CFE_MSG_GetHeaderVersion(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_HeaderVe * Function: CFE_MSG_SetHeaderVersion * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_SetHeaderVersion(CFE_MSG_Message_t *MsgPtr, CFE_MSG_HeaderVersion_t Version) @@ -111,7 +111,7 @@ int32 CFE_MSG_SetHeaderVersion(CFE_MSG_Message_t *MsgPtr, CFE_MSG_HeaderVersion_ * Function: CFE_MSG_GetType * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetType(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_Type_t *Type) @@ -139,7 +139,7 @@ int32 CFE_MSG_GetType(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_Type_t *Type) * Function: CFE_MSG_SetType * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_SetType(CFE_MSG_Message_t *MsgPtr, CFE_MSG_Type_t Type) @@ -172,7 +172,7 @@ int32 CFE_MSG_SetType(CFE_MSG_Message_t *MsgPtr, CFE_MSG_Type_t Type) * Function: CFE_MSG_GetHasSecondaryHeader * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetHasSecondaryHeader(const CFE_MSG_Message_t *MsgPtr, bool *HasSecondary) @@ -193,7 +193,7 @@ int32 CFE_MSG_GetHasSecondaryHeader(const CFE_MSG_Message_t *MsgPtr, bool *HasSe * Function: CFE_MSG_SetHasSecondaryHeader * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_SetHasSecondaryHeader(CFE_MSG_Message_t *MsgPtr, bool HasSecondary) @@ -220,7 +220,7 @@ int32 CFE_MSG_SetHasSecondaryHeader(CFE_MSG_Message_t *MsgPtr, bool HasSecondary * Function: CFE_MSG_GetApId * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetApId(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_ApId_t *ApId) @@ -241,7 +241,7 @@ int32 CFE_MSG_GetApId(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_ApId_t *ApId) * Function: CFE_MSG_SetApId * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_SetApId(CFE_MSG_Message_t *MsgPtr, CFE_MSG_ApId_t ApId) @@ -261,7 +261,7 @@ int32 CFE_MSG_SetApId(CFE_MSG_Message_t *MsgPtr, CFE_MSG_ApId_t ApId) * Function: CFE_MSG_GetSegmentationFlag * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetSegmentationFlag(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_SegmentationFlag_t *SegFlag) @@ -300,7 +300,7 @@ int32 CFE_MSG_GetSegmentationFlag(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_Segme * Function: CFE_MSG_SetSegmentationFlag * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_SetSegmentationFlag(CFE_MSG_Message_t *MsgPtr, CFE_MSG_SegmentationFlag_t SegFlag) @@ -345,7 +345,7 @@ int32 CFE_MSG_SetSegmentationFlag(CFE_MSG_Message_t *MsgPtr, CFE_MSG_Segmentatio * Function: CFE_MSG_GetSequenceCount * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetSequenceCount(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_SequenceCount_t *SeqCnt) @@ -366,7 +366,7 @@ int32 CFE_MSG_GetSequenceCount(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_Sequence * Function: CFE_MSG_SetSequenceCount * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_SetSequenceCount(CFE_MSG_Message_t *MsgPtr, CFE_MSG_SequenceCount_t SeqCnt) @@ -386,7 +386,7 @@ int32 CFE_MSG_SetSequenceCount(CFE_MSG_Message_t *MsgPtr, CFE_MSG_SequenceCount_ * Function: CFE_MSG_GetSize * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetSize(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_Size_t *Size) @@ -407,7 +407,7 @@ int32 CFE_MSG_GetSize(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_Size_t *Size) * Function: CFE_MSG_SetSize * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_SetSize(CFE_MSG_Message_t *MsgPtr, CFE_MSG_Size_t Size) diff --git a/modules/msg/fsw/src/cfe_msg_init.c b/modules/msg/fsw/src/cfe_msg_init.c index 897933d12..8612bbe58 100644 --- a/modules/msg/fsw/src/cfe_msg_init.c +++ b/modules/msg/fsw/src/cfe_msg_init.c @@ -31,7 +31,7 @@ * Function: CFE_MSG_Init * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_Init(CFE_MSG_Message_t *MsgPtr, CFE_SB_MsgId_t MsgId, CFE_MSG_Size_t Size) diff --git a/modules/msg/fsw/src/cfe_msg_initdefaulthdr_pri.c b/modules/msg/fsw/src/cfe_msg_initdefaulthdr_pri.c index 05dcc0c36..60cb353d7 100644 --- a/modules/msg/fsw/src/cfe_msg_initdefaulthdr_pri.c +++ b/modules/msg/fsw/src/cfe_msg_initdefaulthdr_pri.c @@ -30,7 +30,7 @@ * Function: CFE_MSG_InitDefaultHdr * * Application-scope internal function - * See description in cfe_msg_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_MSG_InitDefaultHdr(CFE_MSG_Message_t *MsgPtr) diff --git a/modules/msg/fsw/src/cfe_msg_initdefaulthdr_priext.c b/modules/msg/fsw/src/cfe_msg_initdefaulthdr_priext.c index 0ba1d9153..2b79d7dff 100644 --- a/modules/msg/fsw/src/cfe_msg_initdefaulthdr_priext.c +++ b/modules/msg/fsw/src/cfe_msg_initdefaulthdr_priext.c @@ -30,7 +30,7 @@ * Function: CFE_MSG_InitDefaultHdr * * Application-scope internal function - * See description in cfe_msg_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_MSG_InitDefaultHdr(CFE_MSG_Message_t *MsgPtr) diff --git a/modules/msg/fsw/src/cfe_msg_msgid_shared.c b/modules/msg/fsw/src/cfe_msg_msgid_shared.c index 0b8093244..293730dad 100644 --- a/modules/msg/fsw/src/cfe_msg_msgid_shared.c +++ b/modules/msg/fsw/src/cfe_msg_msgid_shared.c @@ -30,7 +30,7 @@ * Function: CFE_MSG_GetTypeFromMsgId * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetTypeFromMsgId(CFE_SB_MsgId_t MsgId, CFE_MSG_Type_t *Type) diff --git a/modules/msg/fsw/src/cfe_msg_msgid_v1.c b/modules/msg/fsw/src/cfe_msg_msgid_v1.c index 46142af76..5b56c36b6 100644 --- a/modules/msg/fsw/src/cfe_msg_msgid_v1.c +++ b/modules/msg/fsw/src/cfe_msg_msgid_v1.c @@ -32,7 +32,7 @@ * Function: CFE_MSG_GetMsgId * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetMsgId(const CFE_MSG_Message_t *MsgPtr, CFE_SB_MsgId_t *MsgId) @@ -56,7 +56,7 @@ int32 CFE_MSG_GetMsgId(const CFE_MSG_Message_t *MsgPtr, CFE_SB_MsgId_t *MsgId) * Function: CFE_MSG_SetMsgId * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_SetMsgId(CFE_MSG_Message_t *MsgPtr, CFE_SB_MsgId_t MsgId) diff --git a/modules/msg/fsw/src/cfe_msg_msgid_v2.c b/modules/msg/fsw/src/cfe_msg_msgid_v2.c index 89561144f..4757db1a5 100644 --- a/modules/msg/fsw/src/cfe_msg_msgid_v2.c +++ b/modules/msg/fsw/src/cfe_msg_msgid_v2.c @@ -52,7 +52,7 @@ * Function: CFE_MSG_GetMsgId * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetMsgId(const CFE_MSG_Message_t *MsgPtr, CFE_SB_MsgId_t *MsgId) @@ -87,7 +87,7 @@ int32 CFE_MSG_GetMsgId(const CFE_MSG_Message_t *MsgPtr, CFE_SB_MsgId_t *MsgId) * Function: CFE_MSG_SetMsgId * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_SetMsgId(CFE_MSG_Message_t *MsgPtr, CFE_SB_MsgId_t MsgId) diff --git a/modules/msg/fsw/src/cfe_msg_sechdr_checksum.c b/modules/msg/fsw/src/cfe_msg_sechdr_checksum.c index 3b171249d..404222959 100644 --- a/modules/msg/fsw/src/cfe_msg_sechdr_checksum.c +++ b/modules/msg/fsw/src/cfe_msg_sechdr_checksum.c @@ -58,7 +58,7 @@ CFE_MSG_Checksum_t CFE_MSG_ComputeCheckSum(const CFE_MSG_Message_t *MsgPtr) * Function: CFE_MSG_GenerateChecksum * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GenerateChecksum(CFE_MSG_Message_t *MsgPtr) @@ -97,7 +97,7 @@ int32 CFE_MSG_GenerateChecksum(CFE_MSG_Message_t *MsgPtr) * Function: CFE_MSG_ValidateChecksum * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_ValidateChecksum(const CFE_MSG_Message_t *MsgPtr, bool *IsValid) diff --git a/modules/msg/fsw/src/cfe_msg_sechdr_fc.c b/modules/msg/fsw/src/cfe_msg_sechdr_fc.c index c66d18132..6eb2911e1 100644 --- a/modules/msg/fsw/src/cfe_msg_sechdr_fc.c +++ b/modules/msg/fsw/src/cfe_msg_sechdr_fc.c @@ -31,7 +31,7 @@ * Function: CFE_MSG_GetFcnCode * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetFcnCode(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_FcnCode_t *FcnCode) @@ -66,7 +66,7 @@ int32 CFE_MSG_GetFcnCode(const CFE_MSG_Message_t *MsgPtr, CFE_MSG_FcnCode_t *Fcn * Function: CFE_MSG_SetFcnCode * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_SetFcnCode(CFE_MSG_Message_t *MsgPtr, CFE_MSG_FcnCode_t FcnCode) diff --git a/modules/msg/fsw/src/cfe_msg_sechdr_time.c b/modules/msg/fsw/src/cfe_msg_sechdr_time.c index d80951787..66fb9156d 100644 --- a/modules/msg/fsw/src/cfe_msg_sechdr_time.c +++ b/modules/msg/fsw/src/cfe_msg_sechdr_time.c @@ -32,7 +32,7 @@ * Function: CFE_MSG_SetMsgTime * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_SetMsgTime(CFE_MSG_Message_t *MsgPtr, CFE_TIME_SysTime_t NewTime) @@ -73,7 +73,7 @@ int32 CFE_MSG_SetMsgTime(CFE_MSG_Message_t *MsgPtr, CFE_TIME_SysTime_t NewTime) * Function: CFE_MSG_GetMsgTime * * Implemented per public API - * See description in cfe_msg.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_MSG_GetMsgTime(const CFE_MSG_Message_t *MsgPtr, CFE_TIME_SysTime_t *Time) diff --git a/modules/resourceid/fsw/src/cfe_resourceid_api.c b/modules/resourceid/fsw/src/cfe_resourceid_api.c index 0618a875f..461015964 100644 --- a/modules/resourceid/fsw/src/cfe_resourceid_api.c +++ b/modules/resourceid/fsw/src/cfe_resourceid_api.c @@ -46,7 +46,7 @@ * Function: CFE_ResourceId_GetBase * * Implemented per public API - * See description in cfe_resourceid.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ uint32 CFE_ResourceId_GetBase(CFE_ResourceId_t ResourceId) @@ -59,7 +59,7 @@ uint32 CFE_ResourceId_GetBase(CFE_ResourceId_t ResourceId) * Function: CFE_ResourceId_GetSerial * * Implemented per public API - * See description in cfe_resourceid.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ uint32 CFE_ResourceId_GetSerial(CFE_ResourceId_t ResourceId) @@ -72,7 +72,7 @@ uint32 CFE_ResourceId_GetSerial(CFE_ResourceId_t ResourceId) * Function: CFE_ResourceId_ToIndex * * Implemented per public API - * See description in cfe_resourceid.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_ResourceId_ToIndex(CFE_ResourceId_t Id, uint32 BaseValue, uint32 TableSize, uint32 *Idx) @@ -100,7 +100,7 @@ int32 CFE_ResourceId_ToIndex(CFE_ResourceId_t Id, uint32 BaseValue, uint32 Table * Function: CFE_ResourceId_FindNext * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_ResourceId_t CFE_ResourceId_FindNext(CFE_ResourceId_t StartId, uint32 TableSize, diff --git a/modules/sb/fsw/src/cfe_sb_api.c b/modules/sb/fsw/src/cfe_sb_api.c index 4baf7bf2d..d94fead0a 100644 --- a/modules/sb/fsw/src/cfe_sb_api.c +++ b/modules/sb/fsw/src/cfe_sb_api.c @@ -82,7 +82,7 @@ typedef struct * Function: CFE_SB_PipeId_ToIndex * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_Status_t CFE_SB_PipeId_ToIndex(CFE_SB_PipeId_t PipeID, uint32 *Idx) @@ -95,7 +95,7 @@ CFE_Status_t CFE_SB_PipeId_ToIndex(CFE_SB_PipeId_t PipeID, uint32 *Idx) * Function: CFE_SB_CreatePipe * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_CreatePipe(CFE_SB_PipeId_t *PipeIdPtr, uint16 Depth, const char *PipeName) @@ -280,7 +280,7 @@ int32 CFE_SB_CreatePipe(CFE_SB_PipeId_t *PipeIdPtr, uint16 Depth, const char *Pi * Function: CFE_SB_DeletePipe * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_DeletePipe(CFE_SB_PipeId_t PipeId) @@ -301,7 +301,7 @@ int32 CFE_SB_DeletePipe(CFE_SB_PipeId_t PipeId) * Function: CFE_SB_DeletePipeWithAppId * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_DeletePipeWithAppId(CFE_SB_PipeId_t PipeId, CFE_ES_AppId_t AppId) @@ -342,7 +342,7 @@ void CFE_SB_RemovePipeFromRoute(CFE_SBR_RouteId_t RouteId, void *ArgPtr) * Function: CFE_SB_DeletePipeFull * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_DeletePipeFull(CFE_SB_PipeId_t PipeId, CFE_ES_AppId_t AppId) @@ -491,7 +491,7 @@ int32 CFE_SB_DeletePipeFull(CFE_SB_PipeId_t PipeId, CFE_ES_AppId_t AppId) * Function: CFE_SB_SetPipeOpts * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_SetPipeOpts(CFE_SB_PipeId_t PipeId, uint8 Opts) @@ -580,7 +580,7 @@ int32 CFE_SB_SetPipeOpts(CFE_SB_PipeId_t PipeId, uint8 Opts) * Function: CFE_SB_GetPipeOpts * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_GetPipeOpts(CFE_SB_PipeId_t PipeId, uint8 *OptsPtr) @@ -657,7 +657,7 @@ int32 CFE_SB_GetPipeOpts(CFE_SB_PipeId_t PipeId, uint8 *OptsPtr) * Function: CFE_SB_GetPipeName * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_GetPipeName(char *PipeNameBuf, size_t PipeNameSize, CFE_SB_PipeId_t PipeId) @@ -751,7 +751,7 @@ int32 CFE_SB_GetPipeName(char *PipeNameBuf, size_t PipeNameSize, CFE_SB_PipeId_t * Function: CFE_SB_GetPipeIdByName * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_GetPipeIdByName(CFE_SB_PipeId_t *PipeIdPtr, const char *PipeName) @@ -856,7 +856,7 @@ int32 CFE_SB_GetPipeIdByName(CFE_SB_PipeId_t *PipeIdPtr, const char *PipeName) * Function: CFE_SB_SubscribeEx * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_SubscribeEx(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId, CFE_SB_Qos_t Quality, uint16 MsgLim) @@ -869,7 +869,7 @@ int32 CFE_SB_SubscribeEx(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId, CFE_SB_Qo * Function: CFE_SB_SubscribeLocal * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_SubscribeLocal(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId, uint16 MsgLim) @@ -882,7 +882,7 @@ int32 CFE_SB_SubscribeLocal(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId, uint16 * Function: CFE_SB_Subscribe * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_Subscribe(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId) @@ -896,7 +896,7 @@ int32 CFE_SB_Subscribe(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId) * Function: CFE_SB_SubscribeFull * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_SubscribeFull(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId, CFE_SB_Qos_t Quality, uint16 MsgLim, @@ -1137,7 +1137,7 @@ int32 CFE_SB_SubscribeFull(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId, CFE_SB_ * Function: CFE_SB_Unsubscribe * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_Unsubscribe(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId) @@ -1158,7 +1158,7 @@ int32 CFE_SB_Unsubscribe(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId) * Function: CFE_SB_UnsubscribeLocal * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_UnsubscribeLocal(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId) @@ -1179,7 +1179,7 @@ int32 CFE_SB_UnsubscribeLocal(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId) * Function: CFE_SB_UnsubscribeWithAppId * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_UnsubscribeWithAppId(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId, CFE_ES_AppId_t AppId) @@ -1196,7 +1196,7 @@ int32 CFE_SB_UnsubscribeWithAppId(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId, * Function: CFE_SB_UnsubscribeFull * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_UnsubscribeFull(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId, uint8 Scope, CFE_ES_AppId_t AppId) @@ -1320,7 +1320,7 @@ int32 CFE_SB_UnsubscribeFull(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId, uint8 * Function: CFE_SB_TransmitMsg * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_TransmitMsg(CFE_MSG_Message_t *MsgPtr, bool IncrementSequenceCount) @@ -1427,7 +1427,7 @@ int32 CFE_SB_TransmitMsg(CFE_MSG_Message_t *MsgPtr, bool IncrementSequenceCount) * Function: CFE_SB_TransmitMsgValidate * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_TransmitMsgValidate(CFE_MSG_Message_t *MsgPtr, CFE_SB_MsgId_t *MsgIdPtr, CFE_MSG_Size_t *SizePtr, @@ -1544,7 +1544,7 @@ int32 CFE_SB_TransmitMsgValidate(CFE_MSG_Message_t *MsgPtr, CFE_SB_MsgId_t *MsgI * Function: CFE_SB_BroadcastBufferToRoute * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_BroadcastBufferToRoute(CFE_SB_BufferD_t *BufDscPtr, CFE_SBR_RouteId_t RouteId) @@ -1769,7 +1769,7 @@ void CFE_SB_BroadcastBufferToRoute(CFE_SB_BufferD_t *BufDscPtr, CFE_SBR_RouteId_ * Function: CFE_SB_ReceiveBuffer * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_ReceiveBuffer(CFE_SB_Buffer_t **BufPtr, CFE_SB_PipeId_t PipeId, int32 TimeOut) @@ -2026,7 +2026,7 @@ int32 CFE_SB_ReceiveBuffer(CFE_SB_Buffer_t **BufPtr, CFE_SB_PipeId_t PipeId, int * Function: CFE_SB_AllocateMessageBuffer * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_SB_Buffer_t *CFE_SB_AllocateMessageBuffer(size_t MsgSize) @@ -2086,7 +2086,7 @@ CFE_SB_Buffer_t *CFE_SB_AllocateMessageBuffer(size_t MsgSize) * Function: CFE_SB_ZeroCopyBufferValidate * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_ZeroCopyBufferValidate(CFE_SB_Buffer_t *BufPtr, CFE_SB_BufferD_t **BufDscPtr) @@ -2125,7 +2125,7 @@ int32 CFE_SB_ZeroCopyBufferValidate(CFE_SB_Buffer_t *BufPtr, CFE_SB_BufferD_t ** * Function: CFE_SB_ReleaseMessageBuffer * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_Status_t CFE_SB_ReleaseMessageBuffer(CFE_SB_Buffer_t *BufPtr) @@ -2154,7 +2154,7 @@ CFE_Status_t CFE_SB_ReleaseMessageBuffer(CFE_SB_Buffer_t *BufPtr) * Function: CFE_SB_TransmitBuffer * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_TransmitBuffer(CFE_SB_Buffer_t *BufPtr, bool IncrementSequenceCount) diff --git a/modules/sb/fsw/src/cfe_sb_buf.c b/modules/sb/fsw/src/cfe_sb_buf.c index 88342bbc3..a90284c13 100644 --- a/modules/sb/fsw/src/cfe_sb_buf.c +++ b/modules/sb/fsw/src/cfe_sb_buf.c @@ -47,7 +47,7 @@ * Function: CFE_SB_TrackingListReset * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_TrackingListReset(CFE_SB_BufferLink_t *Link) @@ -62,7 +62,7 @@ void CFE_SB_TrackingListReset(CFE_SB_BufferLink_t *Link) * Function: CFE_SB_TrackingListRemove * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_TrackingListRemove(CFE_SB_BufferLink_t *Node) @@ -80,7 +80,7 @@ void CFE_SB_TrackingListRemove(CFE_SB_BufferLink_t *Node) * Function: CFE_SB_TrackingListAdd * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_TrackingListAdd(CFE_SB_BufferLink_t *List, CFE_SB_BufferLink_t *Node) @@ -99,7 +99,7 @@ void CFE_SB_TrackingListAdd(CFE_SB_BufferLink_t *List, CFE_SB_BufferLink_t *Node * Function: CFE_SB_GetBufferFromPool * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_SB_BufferD_t *CFE_SB_GetBufferFromPool(size_t MaxMsgSize) @@ -150,7 +150,7 @@ CFE_SB_BufferD_t *CFE_SB_GetBufferFromPool(size_t MaxMsgSize) * Function: CFE_SB_ReturnBufferToPool * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_ReturnBufferToPool(CFE_SB_BufferD_t *bd) @@ -170,7 +170,7 @@ void CFE_SB_ReturnBufferToPool(CFE_SB_BufferD_t *bd) * Function: CFE_SB_IncrBufUseCnt * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_IncrBufUseCnt(CFE_SB_BufferD_t *bd) @@ -187,7 +187,7 @@ void CFE_SB_IncrBufUseCnt(CFE_SB_BufferD_t *bd) * Function: CFE_SB_DecrBufUseCnt * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_DecrBufUseCnt(CFE_SB_BufferD_t *bd) @@ -209,7 +209,7 @@ void CFE_SB_DecrBufUseCnt(CFE_SB_BufferD_t *bd) * Function: CFE_SB_GetDestinationBlk * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_SB_DestinationD_t *CFE_SB_GetDestinationBlk(void) @@ -240,7 +240,7 @@ CFE_SB_DestinationD_t *CFE_SB_GetDestinationBlk(void) * Function: CFE_SB_PutDestinationBlk * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_PutDestinationBlk(CFE_SB_DestinationD_t *Dest) diff --git a/modules/sb/fsw/src/cfe_sb_init.c b/modules/sb/fsw/src/cfe_sb_init.c index 46beadbe3..b2db162e5 100644 --- a/modules/sb/fsw/src/cfe_sb_init.c +++ b/modules/sb/fsw/src/cfe_sb_init.c @@ -53,7 +53,7 @@ const size_t CFE_SB_MemPoolDefSize[CFE_PLATFORM_ES_POOL_MAX_BUCKETS] = { * Function: CFE_SB_EarlyInit * * Implemented per public API - * See description in cfe_sb_core_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_EarlyInit(void) @@ -100,7 +100,7 @@ int32 CFE_SB_EarlyInit(void) * Function: CFE_SB_InitBuffers * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_InitBuffers(void) @@ -134,7 +134,7 @@ int32 CFE_SB_InitBuffers(void) * Function: CFE_SB_InitPipeTbl * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_InitPipeTbl(void) diff --git a/modules/sb/fsw/src/cfe_sb_msg_id_util.c b/modules/sb/fsw/src/cfe_sb_msg_id_util.c index 6ecc2292b..318372a75 100644 --- a/modules/sb/fsw/src/cfe_sb_msg_id_util.c +++ b/modules/sb/fsw/src/cfe_sb_msg_id_util.c @@ -33,7 +33,7 @@ * Function: CFE_SB_IsValidMsgId * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_SB_IsValidMsgId(CFE_SB_MsgId_t MsgId) diff --git a/modules/sb/fsw/src/cfe_sb_priv.c b/modules/sb/fsw/src/cfe_sb_priv.c index fb56cc38a..cdac4dd25 100644 --- a/modules/sb/fsw/src/cfe_sb_priv.c +++ b/modules/sb/fsw/src/cfe_sb_priv.c @@ -85,7 +85,7 @@ * Function: CFE_SB_CleanUpApp * * Implemented per public API - * See description in cfe_sb_core_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_CleanUpApp(CFE_ES_AppId_t AppId) @@ -129,7 +129,7 @@ int32 CFE_SB_CleanUpApp(CFE_ES_AppId_t AppId) * Function: CFE_SB_LockSharedData * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_LockSharedData(const char *FuncName, int32 LineNumber) @@ -157,7 +157,7 @@ void CFE_SB_LockSharedData(const char *FuncName, int32 LineNumber) * Function: CFE_SB_UnlockSharedData * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_UnlockSharedData(const char *FuncName, int32 LineNumber) @@ -185,7 +185,7 @@ void CFE_SB_UnlockSharedData(const char *FuncName, int32 LineNumber) * Function: CFE_SB_GetDestPtr * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_SB_DestinationD_t *CFE_SB_GetDestPtr(CFE_SBR_RouteId_t RouteId, CFE_SB_PipeId_t PipeId) @@ -212,7 +212,7 @@ CFE_SB_DestinationD_t *CFE_SB_GetDestPtr(CFE_SBR_RouteId_t RouteId, CFE_SB_PipeI * Function: CFE_SB_ValidateMsgId * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_ValidateMsgId(CFE_SB_MsgId_t MsgId) @@ -235,7 +235,7 @@ int32 CFE_SB_ValidateMsgId(CFE_SB_MsgId_t MsgId) * Function: CFE_SB_LocatePipeDescByID * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_SB_PipeD_t *CFE_SB_LocatePipeDescByID(CFE_SB_PipeId_t PipeId) @@ -260,7 +260,7 @@ CFE_SB_PipeD_t *CFE_SB_LocatePipeDescByID(CFE_SB_PipeId_t PipeId) * Function: CFE_SB_CheckPipeDescSlotUsed * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_SB_CheckPipeDescSlotUsed(CFE_ResourceId_t CheckId) @@ -280,7 +280,7 @@ bool CFE_SB_CheckPipeDescSlotUsed(CFE_ResourceId_t CheckId) * Function: CFE_SB_GetAppTskName * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ char *CFE_SB_GetAppTskName(CFE_ES_TaskId_t TaskId, char *FullName) @@ -326,7 +326,7 @@ char *CFE_SB_GetAppTskName(CFE_ES_TaskId_t TaskId, char *FullName) * Function: CFE_SB_RequestToSendEvent * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ uint32 CFE_SB_RequestToSendEvent(CFE_ES_TaskId_t TaskId, uint32 Bit) @@ -359,7 +359,7 @@ uint32 CFE_SB_RequestToSendEvent(CFE_ES_TaskId_t TaskId, uint32 Bit) * Function: CFE_SB_FinishSendEvent * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_FinishSendEvent(CFE_ES_TaskId_t TaskId, uint32 Bit) @@ -381,7 +381,7 @@ void CFE_SB_FinishSendEvent(CFE_ES_TaskId_t TaskId, uint32 Bit) * Function: CFE_SB_AddDestNode * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_AddDestNode(CFE_SBR_RouteId_t RouteId, CFE_SB_DestinationD_t *NewNode) @@ -422,7 +422,7 @@ int32 CFE_SB_AddDestNode(CFE_SBR_RouteId_t RouteId, CFE_SB_DestinationD_t *NewNo * Function: CFE_SB_RemoveDest * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_RemoveDest(CFE_SBR_RouteId_t RouteId, CFE_SB_DestinationD_t *DestPtr) @@ -437,7 +437,7 @@ void CFE_SB_RemoveDest(CFE_SBR_RouteId_t RouteId, CFE_SB_DestinationD_t *DestPtr * Function: CFE_SB_RemoveDestNode * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_RemoveDestNode(CFE_SBR_RouteId_t RouteId, CFE_SB_DestinationD_t *NodeToRemove) @@ -483,7 +483,7 @@ void CFE_SB_RemoveDestNode(CFE_SBR_RouteId_t RouteId, CFE_SB_DestinationD_t *Nod * Function: CFE_SB_ZeroCopyReleaseAppId * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_ZeroCopyReleaseAppId(CFE_ES_AppId_t AppId) diff --git a/modules/sb/fsw/src/cfe_sb_task.c b/modules/sb/fsw/src/cfe_sb_task.c index 4a363f230..99954819a 100644 --- a/modules/sb/fsw/src/cfe_sb_task.c +++ b/modules/sb/fsw/src/cfe_sb_task.c @@ -54,7 +54,7 @@ typedef struct * Function: CFE_SB_TaskMain * * Implemented per public API - * See description in cfe_sb_core_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_TaskMain(void) @@ -116,7 +116,7 @@ void CFE_SB_TaskMain(void) * Function: CFE_SB_AppInit * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_AppInit(void) @@ -323,7 +323,7 @@ bool CFE_SB_VerifyCmdLength(CFE_MSG_Message_t *MsgPtr, size_t ExpectedLength) * Function: CFE_SB_ProcessCmdPipePkt * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_ProcessCmdPipePkt(CFE_SB_Buffer_t *SBBufPtr) @@ -458,7 +458,7 @@ void CFE_SB_ProcessCmdPipePkt(CFE_SB_Buffer_t *SBBufPtr) * Function: CFE_SB_NoopCmd * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_NoopCmd(const CFE_SB_NoopCmd_t *data) @@ -474,7 +474,7 @@ int32 CFE_SB_NoopCmd(const CFE_SB_NoopCmd_t *data) * Function: CFE_SB_ResetCountersCmd * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_ResetCountersCmd(const CFE_SB_ResetCountersCmd_t *data) @@ -491,7 +491,7 @@ int32 CFE_SB_ResetCountersCmd(const CFE_SB_ResetCountersCmd_t *data) * Function: CFE_SB_EnableSubReportingCmd * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_EnableSubReportingCmd(const CFE_SB_EnableSubReportingCmd_t *data) @@ -505,7 +505,7 @@ int32 CFE_SB_EnableSubReportingCmd(const CFE_SB_EnableSubReportingCmd_t *data) * Function: CFE_SB_DisableSubReportingCmd * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_DisableSubReportingCmd(const CFE_SB_DisableSubReportingCmd_t *data) @@ -519,7 +519,7 @@ int32 CFE_SB_DisableSubReportingCmd(const CFE_SB_DisableSubReportingCmd_t *data) * Function: CFE_SB_SendHKTlmCmd * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_SendHKTlmCmd(const CFE_MSG_CommandHeader_t *data) @@ -543,7 +543,7 @@ int32 CFE_SB_SendHKTlmCmd(const CFE_MSG_CommandHeader_t *data) * Function: CFE_SB_ResetCounters * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_ResetCounters(void) @@ -567,7 +567,7 @@ void CFE_SB_ResetCounters(void) * Function: CFE_SB_EnableRouteCmd * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_EnableRouteCmd(const CFE_SB_EnableRouteCmd_t *data) @@ -637,7 +637,7 @@ int32 CFE_SB_EnableRouteCmd(const CFE_SB_EnableRouteCmd_t *data) * Function: CFE_SB_DisableRouteCmd * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_DisableRouteCmd(const CFE_SB_DisableRouteCmd_t *data) @@ -707,7 +707,7 @@ int32 CFE_SB_DisableRouteCmd(const CFE_SB_DisableRouteCmd_t *data) * Function: CFE_SB_SendStatsCmd * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_SendStatsCmd(const CFE_SB_SendSbStatsCmd_t *data) @@ -769,7 +769,7 @@ int32 CFE_SB_SendStatsCmd(const CFE_SB_SendSbStatsCmd_t *data) * Function: CFE_SB_CollectRouteInfo * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_CollectRouteInfo(CFE_SBR_RouteId_t RouteId, void *ArgPtr) @@ -850,7 +850,7 @@ void CFE_SB_CollectRouteInfo(CFE_SBR_RouteId_t RouteId, void *ArgPtr) * Function: CFE_SB_SendSubscriptionReport * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_SendSubscriptionReport(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId, CFE_SB_Qos_t Quality) @@ -884,7 +884,7 @@ int32 CFE_SB_SendSubscriptionReport(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId * Function: CFE_SB_WriteRouteInfoDataGetter * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_SB_WriteRouteInfoDataGetter(void *Meta, uint32 RecordNum, void **Buffer, size_t *BufSize) @@ -918,7 +918,7 @@ bool CFE_SB_WriteRouteInfoDataGetter(void *Meta, uint32 RecordNum, void **Buffer * Function: CFE_SB_BackgroundFileEventHandler * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_BackgroundFileEventHandler(void *Meta, CFE_FS_FileWriteEvent_t Event, int32 Status, uint32 RecordNum, @@ -966,7 +966,7 @@ void CFE_SB_BackgroundFileEventHandler(void *Meta, CFE_FS_FileWriteEvent_t Event * Function: CFE_SB_WriteRoutingInfoCmd * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_WriteRoutingInfoCmd(const CFE_SB_WriteRoutingInfoCmd_t *data) @@ -1029,7 +1029,7 @@ int32 CFE_SB_WriteRoutingInfoCmd(const CFE_SB_WriteRoutingInfoCmd_t *data) * Function: CFE_SB_WritePipeInfoDataGetter * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_SB_WritePipeInfoDataGetter(void *Meta, uint32 RecordNum, void **Buffer, size_t *BufSize) @@ -1109,7 +1109,7 @@ bool CFE_SB_WritePipeInfoDataGetter(void *Meta, uint32 RecordNum, void **Buffer, * Function: CFE_SB_WritePipeInfoCmd * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_WritePipeInfoCmd(const CFE_SB_WritePipeInfoCmd_t *data) @@ -1172,7 +1172,7 @@ int32 CFE_SB_WritePipeInfoCmd(const CFE_SB_WritePipeInfoCmd_t *data) * Function: CFE_SB_CollectMsgMapInfo * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_CollectMsgMapInfo(CFE_SBR_RouteId_t RouteId, void *ArgPtr) @@ -1197,7 +1197,7 @@ void CFE_SB_CollectMsgMapInfo(CFE_SBR_RouteId_t RouteId, void *ArgPtr) * Function: CFE_SB_WriteMsgMapInfoDataGetter * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_SB_WriteMsgMapInfoDataGetter(void *Meta, uint32 RecordNum, void **Buffer, size_t *BufSize) @@ -1239,7 +1239,7 @@ bool CFE_SB_WriteMsgMapInfoDataGetter(void *Meta, uint32 RecordNum, void **Buffe * Function: CFE_SB_WriteMapInfoCmd * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_WriteMapInfoCmd(const CFE_SB_WriteMapInfoCmd_t *data) @@ -1360,7 +1360,7 @@ void CFE_SB_SendRouteSub(CFE_SBR_RouteId_t RouteId, void *ArgPtr) * Function: CFE_SB_SendPrevSubsCmd * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_SendPrevSubsCmd(const CFE_SB_SendPrevSubsCmd_t *data) @@ -1397,7 +1397,7 @@ int32 CFE_SB_SendPrevSubsCmd(const CFE_SB_SendPrevSubsCmd_t *data) * Function: CFE_SB_IncrCmdCtr * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_IncrCmdCtr(int32 status) @@ -1418,7 +1418,7 @@ void CFE_SB_IncrCmdCtr(int32 status) * Function: CFE_SB_SetSubscriptionReporting * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_SetSubscriptionReporting(uint32 state) diff --git a/modules/sb/fsw/src/cfe_sb_util.c b/modules/sb/fsw/src/cfe_sb_util.c index f7ae84c6a..c8f92ba52 100644 --- a/modules/sb/fsw/src/cfe_sb_util.c +++ b/modules/sb/fsw/src/cfe_sb_util.c @@ -42,7 +42,7 @@ * Function: CFE_SB_MsgHdrSize * * Application-scope internal function - * See description in cfe_sb_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ size_t CFE_SB_MsgHdrSize(const CFE_MSG_Message_t *MsgPtr) @@ -82,7 +82,7 @@ size_t CFE_SB_MsgHdrSize(const CFE_MSG_Message_t *MsgPtr) * Function: CFE_SB_GetUserData * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void *CFE_SB_GetUserData(CFE_MSG_Message_t *MsgPtr) @@ -107,7 +107,7 @@ void *CFE_SB_GetUserData(CFE_MSG_Message_t *MsgPtr) * Function: CFE_SB_GetUserDataLength * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ size_t CFE_SB_GetUserDataLength(const CFE_MSG_Message_t *MsgPtr) @@ -131,7 +131,7 @@ size_t CFE_SB_GetUserDataLength(const CFE_MSG_Message_t *MsgPtr) * Function: CFE_SB_SetUserDataLength * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_SetUserDataLength(CFE_MSG_Message_t *MsgPtr, size_t DataLength) @@ -164,7 +164,7 @@ void CFE_SB_SetUserDataLength(CFE_MSG_Message_t *MsgPtr, size_t DataLength) * Function: CFE_SB_TimeStampMsg * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SB_TimeStampMsg(CFE_MSG_Message_t *MsgPtr) @@ -177,7 +177,7 @@ void CFE_SB_TimeStampMsg(CFE_MSG_Message_t *MsgPtr) * Function: CFE_SB_MessageStringGet * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_MessageStringGet(char *DestStringPtr, const char *SourceStringPtr, const char *DefaultString, @@ -234,7 +234,7 @@ int32 CFE_SB_MessageStringGet(char *DestStringPtr, const char *SourceStringPtr, * Function: CFE_SB_MessageStringSet * * Implemented per public API - * See description in cfe_sb.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_SB_MessageStringSet(char *DestStringPtr, const char *SourceStringPtr, size_t DestMaxSize, diff --git a/modules/sbr/fsw/src/cfe_sbr_map_direct.c b/modules/sbr/fsw/src/cfe_sbr_map_direct.c index b1b9c97cb..d8241070a 100644 --- a/modules/sbr/fsw/src/cfe_sbr_map_direct.c +++ b/modules/sbr/fsw/src/cfe_sbr_map_direct.c @@ -61,7 +61,7 @@ CFE_SBR_RouteId_t CFE_SBR_MSGMAP[CFE_SBR_MSG_MAP_SIZE]; * Function: CFE_SBR_Init_Map * * Application-scope internal function - * See description in cfe_sbr_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SBR_Init_Map(void) @@ -75,7 +75,7 @@ void CFE_SBR_Init_Map(void) * Function: CFE_SBR_SetRouteId * * Application-scope internal function - * See description in cfe_sbr_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ uint32 CFE_SBR_SetRouteId(CFE_SB_MsgId_t MsgId, CFE_SBR_RouteId_t RouteId) diff --git a/modules/sbr/fsw/src/cfe_sbr_map_hash.c b/modules/sbr/fsw/src/cfe_sbr_map_hash.c index 53273ffe4..924fd88da 100644 --- a/modules/sbr/fsw/src/cfe_sbr_map_hash.c +++ b/modules/sbr/fsw/src/cfe_sbr_map_hash.c @@ -107,7 +107,7 @@ CFE_SB_MsgId_Atom_t CFE_SBR_MsgIdHash(CFE_SB_MsgId_t MsgId) * Function: CFE_SBR_Init_Map * * Application-scope internal function - * See description in cfe_sbr_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_SBR_Init_Map(void) @@ -121,7 +121,7 @@ void CFE_SBR_Init_Map(void) * Function: CFE_SBR_SetRouteId * * Application-scope internal function - * See description in cfe_sbr_priv.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ uint32 CFE_SBR_SetRouteId(CFE_SB_MsgId_t MsgId, CFE_SBR_RouteId_t RouteId) diff --git a/modules/tbl/fsw/src/cfe_tbl_api.c b/modules/tbl/fsw/src/cfe_tbl_api.c index e15f27502..f4e127b66 100644 --- a/modules/tbl/fsw/src/cfe_tbl_api.c +++ b/modules/tbl/fsw/src/cfe_tbl_api.c @@ -45,7 +45,7 @@ * Function: CFE_TBL_Register * * Implemented per public API - * See description in cfe_tbl.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_Register(CFE_TBL_Handle_t *TblHandlePtr, const char *Name, size_t Size, uint16 TblOptionFlags, @@ -513,7 +513,7 @@ int32 CFE_TBL_Register(CFE_TBL_Handle_t *TblHandlePtr, const char *Name, size_t * Function: CFE_TBL_Share * * Implemented per public API - * See description in cfe_tbl.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_Share(CFE_TBL_Handle_t *TblHandlePtr, const char *TblName) @@ -616,7 +616,7 @@ int32 CFE_TBL_Share(CFE_TBL_Handle_t *TblHandlePtr, const char *TblName) * Function: CFE_TBL_Unregister * * Implemented per public API - * See description in cfe_tbl.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_Unregister(CFE_TBL_Handle_t TblHandle) @@ -681,7 +681,7 @@ int32 CFE_TBL_Unregister(CFE_TBL_Handle_t TblHandle) * Function: CFE_TBL_Load * * Implemented per public API - * See description in cfe_tbl.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_Load(CFE_TBL_Handle_t TblHandle, CFE_TBL_SrcEnum_t SrcType, const void *SrcDataPtr) @@ -912,7 +912,7 @@ int32 CFE_TBL_Load(CFE_TBL_Handle_t TblHandle, CFE_TBL_SrcEnum_t SrcType, const * Function: CFE_TBL_Update * * Implemented per public API - * See description in cfe_tbl_events.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_Update(CFE_TBL_Handle_t TblHandle) @@ -989,7 +989,7 @@ int32 CFE_TBL_Update(CFE_TBL_Handle_t TblHandle) * Function: CFE_TBL_GetAddress * * Implemented per public API - * See description in cfe_tbl.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_GetAddress(void **TblPtr, CFE_TBL_Handle_t TblHandle) @@ -1029,7 +1029,7 @@ int32 CFE_TBL_GetAddress(void **TblPtr, CFE_TBL_Handle_t TblHandle) * Function: CFE_TBL_ReleaseAddress * * Implemented per public API - * See description in cfe_tbl.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_ReleaseAddress(CFE_TBL_Handle_t TblHandle) @@ -1066,7 +1066,7 @@ int32 CFE_TBL_ReleaseAddress(CFE_TBL_Handle_t TblHandle) * Function: CFE_TBL_GetAddresses * * Implemented per public API - * See description in cfe_tbl.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_GetAddresses(void **TblPtrs[], uint16 NumTables, const CFE_TBL_Handle_t TblHandles[]) @@ -1119,7 +1119,7 @@ int32 CFE_TBL_GetAddresses(void **TblPtrs[], uint16 NumTables, const CFE_TBL_Han * Function: CFE_TBL_ReleaseAddresses * * Implemented per public API - * See description in cfe_tbl.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_ReleaseAddresses(uint16 NumTables, const CFE_TBL_Handle_t TblHandles[]) @@ -1150,7 +1150,7 @@ int32 CFE_TBL_ReleaseAddresses(uint16 NumTables, const CFE_TBL_Handle_t TblHandl * Function: CFE_TBL_Validate * * Implemented per public API - * See description in cfe_tbl_events.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_Validate(CFE_TBL_Handle_t TblHandle) @@ -1298,7 +1298,7 @@ int32 CFE_TBL_Validate(CFE_TBL_Handle_t TblHandle) * Function: CFE_TBL_Manage * * Implemented per public API - * See description in cfe_tbl.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_Manage(CFE_TBL_Handle_t TblHandle) @@ -1358,7 +1358,7 @@ int32 CFE_TBL_Manage(CFE_TBL_Handle_t TblHandle) * Function: CFE_TBL_GetStatus * * Implemented per public API - * See description in cfe_tbl.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_GetStatus(CFE_TBL_Handle_t TblHandle) @@ -1406,7 +1406,7 @@ int32 CFE_TBL_GetStatus(CFE_TBL_Handle_t TblHandle) * Function: CFE_TBL_GetInfo * * Implemented per public API - * See description in cfe_tbl.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_GetInfo(CFE_TBL_Info_t *TblInfoPtr, const char *TblName) @@ -1470,7 +1470,7 @@ int32 CFE_TBL_GetInfo(CFE_TBL_Info_t *TblInfoPtr, const char *TblName) * Function: CFE_TBL_DumpToBuffer * * Implemented per public API - * See description in cfe_tbl.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_DumpToBuffer(CFE_TBL_Handle_t TblHandle) @@ -1514,7 +1514,7 @@ int32 CFE_TBL_DumpToBuffer(CFE_TBL_Handle_t TblHandle) * Function: CFE_TBL_Modified * * Implemented per public API - * See description in cfe_tbl.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_Modified(CFE_TBL_Handle_t TblHandle) @@ -1585,7 +1585,7 @@ int32 CFE_TBL_Modified(CFE_TBL_Handle_t TblHandle) * Function: CFE_TBL_NotifyByMessage * * Implemented per public API - * See description in cfe_tbl.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_NotifyByMessage(CFE_TBL_Handle_t TblHandle, CFE_SB_MsgId_t MsgId, CFE_MSG_FcnCode_t CommandCode, diff --git a/modules/tbl/fsw/src/cfe_tbl_internal.c b/modules/tbl/fsw/src/cfe_tbl_internal.c index 013776051..bf65a8145 100644 --- a/modules/tbl/fsw/src/cfe_tbl_internal.c +++ b/modules/tbl/fsw/src/cfe_tbl_internal.c @@ -42,7 +42,7 @@ * Function: CFE_TBL_EarlyInit * * Implemented per public API - * See description in cfe_tbl_core_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_EarlyInit(void) @@ -197,7 +197,7 @@ int32 CFE_TBL_EarlyInit(void) * Function: CFE_TBL_InitRegistryRecord * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TBL_InitRegistryRecord(CFE_TBL_RegistryRec_t *RegRecPtr) @@ -219,7 +219,7 @@ void CFE_TBL_InitRegistryRecord(CFE_TBL_RegistryRec_t *RegRecPtr) * Function: CFE_TBL_ValidateHandle * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_ValidateHandle(CFE_TBL_Handle_t TblHandle) @@ -245,7 +245,7 @@ int32 CFE_TBL_ValidateHandle(CFE_TBL_Handle_t TblHandle) * Function: CFE_TBL_ValidateAccess * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_ValidateAccess(CFE_TBL_Handle_t TblHandle, CFE_ES_AppId_t *AppIdPtr) @@ -278,7 +278,7 @@ int32 CFE_TBL_ValidateAccess(CFE_TBL_Handle_t TblHandle, CFE_ES_AppId_t *AppIdPt * Function: CFE_TBL_CheckAccessRights * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_CheckAccessRights(CFE_TBL_Handle_t TblHandle, CFE_ES_AppId_t ThisAppId) @@ -303,7 +303,7 @@ int32 CFE_TBL_CheckAccessRights(CFE_TBL_Handle_t TblHandle, CFE_ES_AppId_t ThisA * Function: CFE_TBL_RemoveAccessLink * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_RemoveAccessLink(CFE_TBL_Handle_t TblHandle) @@ -399,7 +399,7 @@ int32 CFE_TBL_RemoveAccessLink(CFE_TBL_Handle_t TblHandle) * Function: CFE_TBL_GetAddressInternal * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_GetAddressInternal(void **TblPtr, CFE_TBL_Handle_t TblHandle, CFE_ES_AppId_t ThisAppId) @@ -471,7 +471,7 @@ int32 CFE_TBL_GetAddressInternal(void **TblPtr, CFE_TBL_Handle_t TblHandle, CFE_ * Function: CFE_TBL_GetNextNotification * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_GetNextNotification(CFE_TBL_Handle_t TblHandle) @@ -499,7 +499,7 @@ int32 CFE_TBL_GetNextNotification(CFE_TBL_Handle_t TblHandle) * Function: CFE_TBL_FindTableInRegistry * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int16 CFE_TBL_FindTableInRegistry(const char *TblName) @@ -532,7 +532,7 @@ int16 CFE_TBL_FindTableInRegistry(const char *TblName) * Function: CFE_TBL_FindFreeRegistryEntry * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int16 CFE_TBL_FindFreeRegistryEntry(void) @@ -563,7 +563,7 @@ int16 CFE_TBL_FindFreeRegistryEntry(void) * Function: CFE_TBL_FindFreeHandle * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_TBL_Handle_t CFE_TBL_FindFreeHandle(void) @@ -591,7 +591,7 @@ CFE_TBL_Handle_t CFE_TBL_FindFreeHandle(void) * Function: CFE_TBL_FormTableName * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TBL_FormTableName(char *FullTblName, const char *TblName, CFE_ES_AppId_t ThisAppId) @@ -614,7 +614,7 @@ void CFE_TBL_FormTableName(char *FullTblName, const char *TblName, CFE_ES_AppId_ * Function: CFE_TBL_LockRegistry * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_LockRegistry(void) @@ -636,7 +636,7 @@ int32 CFE_TBL_LockRegistry(void) * Function: CFE_TBL_UnlockRegistry * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_UnlockRegistry(void) @@ -658,7 +658,7 @@ int32 CFE_TBL_UnlockRegistry(void) * Function: CFE_TBL_GetWorkingBuffer * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_GetWorkingBuffer(CFE_TBL_LoadBuff_t **WorkingBufferPtr, CFE_TBL_RegistryRec_t *RegRecPtr, @@ -794,7 +794,7 @@ int32 CFE_TBL_GetWorkingBuffer(CFE_TBL_LoadBuff_t **WorkingBufferPtr, CFE_TBL_Re * Function: CFE_TBL_LoadFromFile * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_LoadFromFile(const char *AppName, CFE_TBL_LoadBuff_t *WorkingBufferPtr, CFE_TBL_RegistryRec_t *RegRecPtr, @@ -921,7 +921,7 @@ int32 CFE_TBL_LoadFromFile(const char *AppName, CFE_TBL_LoadBuff_t *WorkingBuffe * Function: CFE_TBL_UpdateInternal * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_UpdateInternal(CFE_TBL_Handle_t TblHandle, CFE_TBL_RegistryRec_t *RegRecPtr, @@ -1025,7 +1025,7 @@ int32 CFE_TBL_UpdateInternal(CFE_TBL_Handle_t TblHandle, CFE_TBL_RegistryRec_t * * Function: CFE_TBL_NotifyTblUsersOfUpdate * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TBL_NotifyTblUsersOfUpdate(CFE_TBL_RegistryRec_t *RegRecPtr) @@ -1053,7 +1053,7 @@ void CFE_TBL_NotifyTblUsersOfUpdate(CFE_TBL_RegistryRec_t *RegRecPtr) * Function: CFE_TBL_ReadHeaders * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_ReadHeaders(osal_id_t FileDescriptor, CFE_FS_Header_t *StdFileHeaderPtr, @@ -1201,7 +1201,7 @@ int32 CFE_TBL_ReadHeaders(osal_id_t FileDescriptor, CFE_FS_Header_t *StdFileHead * Function: CFE_TBL_ByteSwapTblHeader * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TBL_ByteSwapTblHeader(CFE_TBL_File_Hdr_t *HdrPtr) @@ -1216,7 +1216,7 @@ void CFE_TBL_ByteSwapTblHeader(CFE_TBL_File_Hdr_t *HdrPtr) * Function: CFE_TBL_ByteSwapUint32 * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TBL_ByteSwapUint32(uint32 *Uint32ToSwapPtr) @@ -1236,7 +1236,7 @@ void CFE_TBL_ByteSwapUint32(uint32 *Uint32ToSwapPtr) * Function: CFE_TBL_CleanUpApp * * Implemented per public API - * See description in cfe_tbl_core_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_CleanUpApp(CFE_ES_AppId_t AppId) @@ -1303,7 +1303,7 @@ int32 CFE_TBL_CleanUpApp(CFE_ES_AppId_t AppId) * Function: CFE_TBL_FindCriticalTblInfo * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TBL_FindCriticalTblInfo(CFE_TBL_CritRegRec_t **CritRegRecPtr, CFE_ES_CDSHandle_t CDSHandleToFind) @@ -1328,7 +1328,7 @@ void CFE_TBL_FindCriticalTblInfo(CFE_TBL_CritRegRec_t **CritRegRecPtr, CFE_ES_CD * Function: CFE_TBL_UpdateCriticalTblCDS * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TBL_UpdateCriticalTblCDS(CFE_TBL_RegistryRec_t *RegRecPtr) @@ -1386,7 +1386,7 @@ void CFE_TBL_UpdateCriticalTblCDS(CFE_TBL_RegistryRec_t *RegRecPtr) * Function: CFE_TBL_SendNotificationMsg * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_SendNotificationMsg(CFE_TBL_RegistryRec_t *RegRecPtr) diff --git a/modules/tbl/fsw/src/cfe_tbl_task.c b/modules/tbl/fsw/src/cfe_tbl_task.c index 9b181f90f..6ee1e4efc 100644 --- a/modules/tbl/fsw/src/cfe_tbl_task.c +++ b/modules/tbl/fsw/src/cfe_tbl_task.c @@ -90,7 +90,7 @@ const CFE_TBL_CmdHandlerTblRec_t CFE_TBL_CmdHandlerTbl[] = { * Function: CFE_TBL_TaskMain * * Implemented per public API - * See description in cfe_tbl_core_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TBL_TaskMain(void) @@ -152,7 +152,7 @@ void CFE_TBL_TaskMain(void) * Function: CFE_TBL_TaskInit * * Application-scope internal function - * See description in cfe_tbl_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_TaskInit(void) @@ -227,7 +227,7 @@ int32 CFE_TBL_TaskInit(void) * Function: CFE_TBL_InitData * * Application-scope internal function - * See description in cfe_tbl_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TBL_InitData(void) @@ -252,7 +252,7 @@ void CFE_TBL_InitData(void) * Function: CFE_TBL_TaskPipe * * Application-scope internal function - * See description in cfe_tbl_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TBL_TaskPipe(CFE_SB_Buffer_t *SBBufPtr) @@ -332,7 +332,7 @@ void CFE_TBL_TaskPipe(CFE_SB_Buffer_t *SBBufPtr) * Function: CFE_TBL_SearchCmdHndlrTbl * * Application-scope internal function - * See description in cfe_tbl_task.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int16 CFE_TBL_SearchCmdHndlrTbl(CFE_SB_MsgId_t MessageID, uint16 CommandCode) diff --git a/modules/tbl/fsw/src/cfe_tbl_task_cmds.c b/modules/tbl/fsw/src/cfe_tbl_task_cmds.c index e09e240ef..9a619b2ca 100644 --- a/modules/tbl/fsw/src/cfe_tbl_task_cmds.c +++ b/modules/tbl/fsw/src/cfe_tbl_task_cmds.c @@ -42,7 +42,7 @@ * Function: CFE_TBL_HousekeepingCmd * * Application-scope internal function - * See description in cfe_tbl_task_cmds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_HousekeepingCmd(const CFE_MSG_CommandHeader_t *data) @@ -140,7 +140,7 @@ int32 CFE_TBL_HousekeepingCmd(const CFE_MSG_CommandHeader_t *data) * Function: CFE_TBL_GetHkData * * Application-scope internal function - * See description in cfe_tbl_task_cmds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TBL_GetHkData(void) @@ -254,7 +254,7 @@ void CFE_TBL_GetHkData(void) * Function: CFE_TBL_GetTblRegData * * Application-scope internal function - * See description in cfe_tbl_task_cmds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TBL_GetTblRegData(void) @@ -314,7 +314,7 @@ void CFE_TBL_GetTblRegData(void) * Function: CFE_TBL_NoopCmd * * Application-scope internal function - * See description in cfe_tbl_task_cmds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_NoopCmd(const CFE_TBL_NoopCmd_t *data) @@ -330,7 +330,7 @@ int32 CFE_TBL_NoopCmd(const CFE_TBL_NoopCmd_t *data) * Function: CFE_TBL_ResetCountersCmd * * Application-scope internal function - * See description in cfe_tbl_task_cmds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_ResetCountersCmd(const CFE_TBL_ResetCountersCmd_t *data) @@ -352,7 +352,7 @@ int32 CFE_TBL_ResetCountersCmd(const CFE_TBL_ResetCountersCmd_t *data) * Function: CFE_TBL_LoadCmd * * Application-scope internal function - * See description in cfe_tbl_task_cmds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_LoadCmd(const CFE_TBL_LoadCmd_t *data) @@ -543,7 +543,7 @@ int32 CFE_TBL_LoadCmd(const CFE_TBL_LoadCmd_t *data) * Function: CFE_TBL_DumpCmd * * Application-scope internal function - * See description in cfe_tbl_task_cmds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_DumpCmd(const CFE_TBL_DumpCmd_t *data) @@ -689,7 +689,7 @@ int32 CFE_TBL_DumpCmd(const CFE_TBL_DumpCmd_t *data) * Function: CFE_TBL_DumpToFile * * Application-scope internal function - * See description in cfe_tbl_task_cmds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_TBL_CmdProcRet_t CFE_TBL_DumpToFile(const char *DumpFilename, const char *TableName, const void *DumpDataAddr, @@ -815,7 +815,7 @@ CFE_TBL_CmdProcRet_t CFE_TBL_DumpToFile(const char *DumpFilename, const char *Ta * Function: CFE_TBL_ValidateCmd * * Application-scope internal function - * See description in cfe_tbl_task_cmds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_ValidateCmd(const CFE_TBL_ValidateCmd_t *data) @@ -958,7 +958,7 @@ int32 CFE_TBL_ValidateCmd(const CFE_TBL_ValidateCmd_t *data) * Function: CFE_TBL_ActivateCmd * * Application-scope internal function - * See description in cfe_tbl_task_cmds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_ActivateCmd(const CFE_TBL_ActivateCmd_t *data) @@ -1038,7 +1038,7 @@ int32 CFE_TBL_ActivateCmd(const CFE_TBL_ActivateCmd_t *data) * Function: CFE_TBL_DumpRegistryGetter * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ bool CFE_TBL_DumpRegistryGetter(void *Meta, uint32 RecordNum, void **Buffer, size_t *BufSize) @@ -1158,7 +1158,7 @@ bool CFE_TBL_DumpRegistryGetter(void *Meta, uint32 RecordNum, void **Buffer, siz * Function: CFE_TBL_DumpRegistryEventHandler * * Application-scope internal function - * See description in cfe_tbl_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TBL_DumpRegistryEventHandler(void *Meta, CFE_FS_FileWriteEvent_t Event, int32 Status, uint32 RecordNum, @@ -1222,7 +1222,7 @@ void CFE_TBL_DumpRegistryEventHandler(void *Meta, CFE_FS_FileWriteEvent_t Event, * Function: CFE_TBL_DumpRegistryCmd * * Application-scope internal function - * See description in cfe_tbl_task_cmds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_DumpRegistryCmd(const CFE_TBL_DumpRegistryCmd_t *data) @@ -1285,7 +1285,7 @@ int32 CFE_TBL_DumpRegistryCmd(const CFE_TBL_DumpRegistryCmd_t *data) * Function: CFE_TBL_SendRegistryCmd * * Application-scope internal function - * See description in cfe_tbl_task_cmds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_SendRegistryCmd(const CFE_TBL_SendRegistryCmd_t *data) @@ -1326,7 +1326,7 @@ int32 CFE_TBL_SendRegistryCmd(const CFE_TBL_SendRegistryCmd_t *data) * Function: CFE_TBL_DeleteCDSCmd * * Application-scope internal function - * See description in cfe_tbl_task_cmds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_DeleteCDSCmd(const CFE_TBL_DeleteCDSCmd_t *data) @@ -1416,7 +1416,7 @@ int32 CFE_TBL_DeleteCDSCmd(const CFE_TBL_DeleteCDSCmd_t *data) * Function: CFE_TBL_AbortLoadCmd * * Application-scope internal function - * See description in cfe_tbl_task_cmds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TBL_AbortLoadCmd(const CFE_TBL_AbortLoadCmd_t *data) @@ -1468,7 +1468,7 @@ int32 CFE_TBL_AbortLoadCmd(const CFE_TBL_AbortLoadCmd_t *data) * Function: CFE_TBL_AbortLoad * * Application-scope internal function - * See description in cfe_tbl_task_cmds.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TBL_AbortLoad(CFE_TBL_RegistryRec_t *RegRecPtr) diff --git a/modules/time/fsw/src/cfe_time_api.c b/modules/time/fsw/src/cfe_time_api.c index 70ad086fb..2bf4e9bd1 100644 --- a/modules/time/fsw/src/cfe_time_api.c +++ b/modules/time/fsw/src/cfe_time_api.c @@ -41,7 +41,7 @@ * Function: CFE_TIME_GetTime * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_TIME_SysTime_t CFE_TIME_GetTime(void) @@ -66,7 +66,7 @@ CFE_TIME_SysTime_t CFE_TIME_GetTime(void) * Function: CFE_TIME_GetTAI * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_TIME_SysTime_t CFE_TIME_GetTAI(void) @@ -97,7 +97,7 @@ CFE_TIME_SysTime_t CFE_TIME_GetTAI(void) * Function: CFE_TIME_GetUTC * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_TIME_SysTime_t CFE_TIME_GetUTC(void) @@ -127,7 +127,7 @@ CFE_TIME_SysTime_t CFE_TIME_GetUTC(void) * Function: CFE_TIME_MET2SCTime * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_TIME_SysTime_t CFE_TIME_MET2SCTime(CFE_TIME_SysTime_t METTime) @@ -168,7 +168,7 @@ CFE_TIME_SysTime_t CFE_TIME_MET2SCTime(CFE_TIME_SysTime_t METTime) * Function: CFE_TIME_GetClockState * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_TIME_ClockState_Enum_t CFE_TIME_GetClockState(void) @@ -198,7 +198,7 @@ CFE_TIME_ClockState_Enum_t CFE_TIME_GetClockState(void) * Function: CFE_TIME_GetClockInfo * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ uint16 CFE_TIME_GetClockInfo(void) @@ -292,7 +292,7 @@ uint16 CFE_TIME_GetClockInfo(void) * Function: CFE_TIME_GetLeapSeconds * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int16 CFE_TIME_GetLeapSeconds(void) @@ -317,7 +317,7 @@ int16 CFE_TIME_GetLeapSeconds(void) * Function: CFE_TIME_GetSTCF * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_TIME_SysTime_t CFE_TIME_GetSTCF(void) @@ -342,7 +342,7 @@ CFE_TIME_SysTime_t CFE_TIME_GetSTCF(void) * Function: CFE_TIME_GetMET * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_TIME_SysTime_t CFE_TIME_GetMET(void) @@ -367,7 +367,7 @@ CFE_TIME_SysTime_t CFE_TIME_GetMET(void) * Function: CFE_TIME_GetMETseconds * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ uint32 CFE_TIME_GetMETseconds(void) @@ -392,7 +392,7 @@ uint32 CFE_TIME_GetMETseconds(void) * Function: CFE_TIME_GetMETsubsecs * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ uint32 CFE_TIME_GetMETsubsecs(void) @@ -417,7 +417,7 @@ uint32 CFE_TIME_GetMETsubsecs(void) * Function: CFE_TIME_Add * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_TIME_SysTime_t CFE_TIME_Add(CFE_TIME_SysTime_t Time1, CFE_TIME_SysTime_t Time2) @@ -446,7 +446,7 @@ CFE_TIME_SysTime_t CFE_TIME_Add(CFE_TIME_SysTime_t Time1, CFE_TIME_SysTime_t Tim * Function: CFE_TIME_Subtract * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_TIME_SysTime_t CFE_TIME_Subtract(CFE_TIME_SysTime_t Time1, CFE_TIME_SysTime_t Time2) @@ -472,7 +472,7 @@ CFE_TIME_SysTime_t CFE_TIME_Subtract(CFE_TIME_SysTime_t Time1, CFE_TIME_SysTime_ * Function: CFE_TIME_Compare * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_TIME_Compare_t CFE_TIME_Compare(CFE_TIME_SysTime_t TimeA, CFE_TIME_SysTime_t TimeB) @@ -534,7 +534,7 @@ CFE_TIME_Compare_t CFE_TIME_Compare(CFE_TIME_SysTime_t TimeA, CFE_TIME_SysTime_t * Function: CFE_TIME_Sub2MicroSecs * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ uint32 CFE_TIME_Sub2MicroSecs(uint32 SubSeconds) @@ -556,7 +556,7 @@ uint32 CFE_TIME_Sub2MicroSecs(uint32 SubSeconds) * Function: CFE_TIME_Micro2SubSecs * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ uint32 CFE_TIME_Micro2SubSecs(uint32 MicroSeconds) @@ -589,7 +589,7 @@ uint32 CFE_TIME_Micro2SubSecs(uint32 MicroSeconds) * Function: CFE_TIME_Print * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_Print(char *PrintBuffer, CFE_TIME_SysTime_t TimeToPrint) @@ -741,7 +741,7 @@ void CFE_TIME_Print(char *PrintBuffer, CFE_TIME_SysTime_t TimeToPrint) * Function: CFE_TIME_ExternalTone * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_ExternalTone(void) @@ -759,7 +759,7 @@ void CFE_TIME_ExternalTone(void) * Function: CFE_TIME_RegisterSynchCallback * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_RegisterSynchCallback(CFE_TIME_SynchCallbackPtr_t CallbackFuncPtr) @@ -801,7 +801,7 @@ int32 CFE_TIME_RegisterSynchCallback(CFE_TIME_SynchCallbackPtr_t CallbackFuncPtr * Function: CFE_TIME_UnregisterSynchCallback * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_UnregisterSynchCallback(CFE_TIME_SynchCallbackPtr_t CallbackFuncPtr) @@ -843,7 +843,7 @@ int32 CFE_TIME_UnregisterSynchCallback(CFE_TIME_SynchCallbackPtr_t CallbackFuncP * Function: CFE_TIME_ExternalMET * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_SRC_MET == true) @@ -863,7 +863,7 @@ void CFE_TIME_ExternalMET(CFE_TIME_SysTime_t NewMET) * Function: CFE_TIME_ExternalGPS * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_SRC_GPS == true) @@ -883,7 +883,7 @@ void CFE_TIME_ExternalGPS(CFE_TIME_SysTime_t NewTime, int16 NewLeaps) * Function: CFE_TIME_ExternalTime * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_SRC_TIME == true) diff --git a/modules/time/fsw/src/cfe_time_task.c b/modules/time/fsw/src/cfe_time_task.c index 80f7fd8ab..112e2d775 100644 --- a/modules/time/fsw/src/cfe_time_task.c +++ b/modules/time/fsw/src/cfe_time_task.c @@ -45,7 +45,7 @@ CFE_TIME_Global_t CFE_TIME_Global; * Function: CFE_TIME_EarlyInit * * Implemented per public API - * See description in cfe_time_core_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_EarlyInit(void) @@ -63,7 +63,7 @@ int32 CFE_TIME_EarlyInit(void) * Function: CFE_TIME_TaskMain * * Implemented per public API - * See description in cfe_time_core_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_TaskMain(void) @@ -126,7 +126,7 @@ void CFE_TIME_TaskMain(void) * Function: CFE_TIME_TaskInit * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_TaskInit(void) @@ -349,7 +349,7 @@ bool CFE_TIME_VerifyCmdLength(CFE_MSG_Message_t *MsgPtr, size_t ExpectedLength) * Function: CFE_TIME_TaskPipe * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_TaskPipe(CFE_SB_Buffer_t *SBBufPtr) @@ -554,7 +554,7 @@ void CFE_TIME_TaskPipe(CFE_SB_Buffer_t *SBBufPtr) * Function: CFE_TIME_HousekeepingCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_HousekeepingCmd(const CFE_MSG_CommandHeader_t *data) @@ -594,7 +594,7 @@ int32 CFE_TIME_HousekeepingCmd(const CFE_MSG_CommandHeader_t *data) * Function: CFE_TIME_ToneSignalCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_ToneSignalCmd(const CFE_TIME_ToneSignalCmd_t *data) @@ -616,7 +616,7 @@ int32 CFE_TIME_ToneSignalCmd(const CFE_TIME_ToneSignalCmd_t *data) * Function: CFE_TIME_ToneDataCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_ToneDataCmd(const CFE_TIME_ToneDataCmd_t *data) @@ -638,7 +638,7 @@ int32 CFE_TIME_ToneDataCmd(const CFE_TIME_ToneDataCmd_t *data) * Function: CFE_TIME_OneHzCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_OneHzCmd(const CFE_TIME_1HzCmd_t *data) @@ -670,7 +670,7 @@ int32 CFE_TIME_OneHzCmd(const CFE_TIME_1HzCmd_t *data) * Function: CFE_TIME_ToneSendCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_SERVER == true) @@ -694,7 +694,7 @@ int32 CFE_TIME_ToneSendCmd(const CFE_TIME_FakeToneCmd_t *data) * Function: CFE_TIME_NoopCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_NoopCmd(const CFE_TIME_NoopCmd_t *data) @@ -712,7 +712,7 @@ int32 CFE_TIME_NoopCmd(const CFE_TIME_NoopCmd_t *data) * Function: CFE_TIME_ResetCountersCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_ResetCountersCmd(const CFE_TIME_ResetCountersCmd_t *data) @@ -753,7 +753,7 @@ int32 CFE_TIME_ResetCountersCmd(const CFE_TIME_ResetCountersCmd_t *data) * Function: CFE_TIME_SendDiagnosticTlm * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_SendDiagnosticTlm(const CFE_TIME_SendDiagnosticCmd_t *data) @@ -781,7 +781,7 @@ int32 CFE_TIME_SendDiagnosticTlm(const CFE_TIME_SendDiagnosticCmd_t *data) * Function: CFE_TIME_SetStateCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_SetStateCmd(const CFE_TIME_SetStateCmd_t *data) @@ -832,7 +832,7 @@ int32 CFE_TIME_SetStateCmd(const CFE_TIME_SetStateCmd_t *data) * Function: CFE_TIME_SetSourceCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_SetSourceCmd(const CFE_TIME_SetSourceCmd_t *data) @@ -901,7 +901,7 @@ int32 CFE_TIME_SetSourceCmd(const CFE_TIME_SetSourceCmd_t *data) * Function: CFE_TIME_SetSignalCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_SetSignalCmd(const CFE_TIME_SetSignalCmd_t *data) @@ -970,7 +970,7 @@ int32 CFE_TIME_SetSignalCmd(const CFE_TIME_SetSignalCmd_t *data) * Function: CFE_TIME_SetDelayImpl * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_SetDelayImpl(const CFE_TIME_TimeCmd_Payload_t *CommandPtr, CFE_TIME_AdjustDirection_Enum_t Direction) @@ -1020,7 +1020,7 @@ void CFE_TIME_SetDelayImpl(const CFE_TIME_TimeCmd_Payload_t *CommandPtr, CFE_TIM * Function: CFE_TIME_AddDelayCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_AddDelayCmd(const CFE_TIME_AddDelayCmd_t *data) @@ -1034,7 +1034,7 @@ int32 CFE_TIME_AddDelayCmd(const CFE_TIME_AddDelayCmd_t *data) * Function: CFE_TIME_SubDelayCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_SubDelayCmd(const CFE_TIME_SubDelayCmd_t *data) @@ -1048,7 +1048,7 @@ int32 CFE_TIME_SubDelayCmd(const CFE_TIME_SubDelayCmd_t *data) * Function: CFE_TIME_SetTimeCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_SetTimeCmd(const CFE_TIME_SetTimeCmd_t *data) @@ -1101,7 +1101,7 @@ int32 CFE_TIME_SetTimeCmd(const CFE_TIME_SetTimeCmd_t *data) * Function: CFE_TIME_SetMETCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_SetMETCmd(const CFE_TIME_SetMETCmd_t *data) @@ -1154,7 +1154,7 @@ int32 CFE_TIME_SetMETCmd(const CFE_TIME_SetMETCmd_t *data) * Function: CFE_TIME_SetSTCFCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_SetSTCFCmd(const CFE_TIME_SetSTCFCmd_t *data) @@ -1207,7 +1207,7 @@ int32 CFE_TIME_SetSTCFCmd(const CFE_TIME_SetSTCFCmd_t *data) * Function: CFE_TIME_SetLeapSecondsCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_SetLeapSecondsCmd(const CFE_TIME_SetLeapSecondsCmd_t *data) @@ -1245,7 +1245,7 @@ int32 CFE_TIME_SetLeapSecondsCmd(const CFE_TIME_SetLeapSecondsCmd_t *data) * Function: CFE_TIME_AdjustImpl * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_AdjustImpl(const CFE_TIME_TimeCmd_Payload_t *CommandPtr, CFE_TIME_AdjustDirection_Enum_t Direction) @@ -1295,7 +1295,7 @@ void CFE_TIME_AdjustImpl(const CFE_TIME_TimeCmd_Payload_t *CommandPtr, CFE_TIME_ * Function: CFE_TIME_AddAdjustCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_AddAdjustCmd(const CFE_TIME_AddAdjustCmd_t *data) @@ -1309,7 +1309,7 @@ int32 CFE_TIME_AddAdjustCmd(const CFE_TIME_AddAdjustCmd_t *data) * Function: CFE_TIME_SubAdjustCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_SubAdjustCmd(const CFE_TIME_SubAdjustCmd_t *data) @@ -1323,7 +1323,7 @@ int32 CFE_TIME_SubAdjustCmd(const CFE_TIME_SubAdjustCmd_t *data) * Function: CFE_TIME_1HzAdjImpl * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_1HzAdjImpl(const CFE_TIME_OneHzAdjustmentCmd_Payload_t *CommandPtr, @@ -1362,7 +1362,7 @@ void CFE_TIME_1HzAdjImpl(const CFE_TIME_OneHzAdjustmentCmd_Payload_t *CommandPtr * Function: CFE_TIME_Add1HZAdjustmentCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_Add1HZAdjustmentCmd(const CFE_TIME_Add1HZAdjustmentCmd_t *data) @@ -1376,7 +1376,7 @@ int32 CFE_TIME_Add1HZAdjustmentCmd(const CFE_TIME_Add1HZAdjustmentCmd_t *data) * Function: CFE_TIME_Sub1HZAdjustmentCmd * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_Sub1HZAdjustmentCmd(const CFE_TIME_Sub1HZAdjustmentCmd_t *data) diff --git a/modules/time/fsw/src/cfe_time_tone.c b/modules/time/fsw/src/cfe_time_tone.c index 4780324ed..3b867cb3d 100644 --- a/modules/time/fsw/src/cfe_time_tone.c +++ b/modules/time/fsw/src/cfe_time_tone.c @@ -48,7 +48,7 @@ * Function: CFE_TIME_ToneSend * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_SERVER == true) @@ -170,7 +170,7 @@ void CFE_TIME_ToneSend(void) * Function: CFE_TIME_ToneSendMET * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_SRC_MET == true) @@ -303,7 +303,7 @@ int32 CFE_TIME_ToneSendMET(CFE_TIME_SysTime_t NewMET) * Function: CFE_TIME_ToneSendGPS * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_SRC_GPS == true) @@ -443,7 +443,7 @@ int32 CFE_TIME_ToneSendGPS(CFE_TIME_SysTime_t NewTime, int16 NewLeaps) * Function: CFE_TIME_ToneSendTime * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_SRC_TIME == true) @@ -585,7 +585,7 @@ int32 CFE_TIME_ToneSendTime(CFE_TIME_SysTime_t NewTime) * Function: CFE_TIME_ToneData * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_ToneData(const CFE_TIME_ToneDataCmd_Payload_t *ToneDataCmd) @@ -657,7 +657,7 @@ void CFE_TIME_ToneData(const CFE_TIME_ToneDataCmd_Payload_t *ToneDataCmd) * Function: CFE_TIME_ToneSignal * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_ToneSignal(void) @@ -700,7 +700,7 @@ void CFE_TIME_ToneSignal(void) * Function: CFE_TIME_ToneVerify * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_ToneVerify(CFE_TIME_SysTime_t Time1, CFE_TIME_SysTime_t Time2) @@ -788,7 +788,7 @@ void CFE_TIME_ToneVerify(CFE_TIME_SysTime_t Time1, CFE_TIME_SysTime_t Time2) * Function: CFE_TIME_ToneUpdate * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_ToneUpdate(void) @@ -979,7 +979,7 @@ void CFE_TIME_ToneUpdate(void) * Function: CFE_TIME_Local1HzTimerCallback * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_Local1HzTimerCallback(osal_id_t TimerId, void *Arg) @@ -992,7 +992,7 @@ void CFE_TIME_Local1HzTimerCallback(osal_id_t TimerId, void *Arg) * Function: CFE_TIME_Tone1HzISR * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_Tone1HzISR(void) @@ -1101,7 +1101,7 @@ void CFE_TIME_Tone1HzISR(void) * Function: CFE_TIME_Tone1HzTask * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_Tone1HzTask(void) @@ -1160,7 +1160,7 @@ void CFE_TIME_Tone1HzTask(void) * Function: CFE_TIME_Local1HzStateMachine * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_Local1HzStateMachine(void) @@ -1278,7 +1278,7 @@ void CFE_TIME_Local1HzStateMachine(void) * Function: CFE_TIME_Local1HzISR * * Implemented per public API - * See description in cfe_time.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_Local1HzISR(void) @@ -1299,7 +1299,7 @@ void CFE_TIME_Local1HzISR(void) * Function: CFE_TIME_Local1HzTask * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_Local1HzTask(void) @@ -1359,7 +1359,7 @@ void CFE_TIME_Local1HzTask(void) * Function: CFE_TIME_NotifyTimeSynchApps * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_NotifyTimeSynchApps(void) diff --git a/modules/time/fsw/src/cfe_time_utils.c b/modules/time/fsw/src/cfe_time_utils.c index 5b7852314..764cd0acd 100644 --- a/modules/time/fsw/src/cfe_time_utils.c +++ b/modules/time/fsw/src/cfe_time_utils.c @@ -47,7 +47,7 @@ * Function: CFE_TIME_StartReferenceUpdate * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ volatile CFE_TIME_ReferenceState_t *CFE_TIME_StartReferenceUpdate(void) @@ -80,7 +80,7 @@ volatile CFE_TIME_ReferenceState_t *CFE_TIME_StartReferenceUpdate(void) * Function: CFE_TIME_LatchClock * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_TIME_SysTime_t CFE_TIME_LatchClock(void) @@ -107,7 +107,7 @@ CFE_TIME_SysTime_t CFE_TIME_LatchClock(void) * Function: CFE_TIME_QueryResetVars * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_QueryResetVars(void) @@ -197,7 +197,7 @@ void CFE_TIME_QueryResetVars(void) * Function: CFE_TIME_UpdateResetVars * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_UpdateResetVars(const CFE_TIME_Reference_t *Reference) @@ -241,7 +241,7 @@ void CFE_TIME_UpdateResetVars(const CFE_TIME_Reference_t *Reference) * Function: CFE_TIME_InitData * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_InitData(void) @@ -378,7 +378,7 @@ void CFE_TIME_InitData(void) * Function: CFE_TIME_GetHkData * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_GetHkData(const CFE_TIME_Reference_t *Reference) @@ -438,7 +438,7 @@ void CFE_TIME_GetHkData(const CFE_TIME_Reference_t *Reference) * Function: CFE_TIME_GetDiagData * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_GetDiagData(void) @@ -560,7 +560,7 @@ void CFE_TIME_GetDiagData(void) * Function: CFE_TIME_GetReference * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_GetReference(CFE_TIME_Reference_t *Reference) @@ -669,7 +669,7 @@ void CFE_TIME_GetReference(CFE_TIME_Reference_t *Reference) * Function: CFE_TIME_CalculateTAI * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_TIME_SysTime_t CFE_TIME_CalculateTAI(const CFE_TIME_Reference_t *Reference) @@ -686,7 +686,7 @@ CFE_TIME_SysTime_t CFE_TIME_CalculateTAI(const CFE_TIME_Reference_t *Reference) * Function: CFE_TIME_CalculateUTC * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ CFE_TIME_SysTime_t CFE_TIME_CalculateUTC(const CFE_TIME_Reference_t *Reference) @@ -704,7 +704,7 @@ CFE_TIME_SysTime_t CFE_TIME_CalculateUTC(const CFE_TIME_Reference_t *Reference) * Function: CFE_TIME_CalculateState * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int16 CFE_TIME_CalculateState(const CFE_TIME_Reference_t *Reference) @@ -758,7 +758,7 @@ int16 CFE_TIME_CalculateState(const CFE_TIME_Reference_t *Reference) * Function: CFE_TIME_SetState * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ void CFE_TIME_SetState(int16 NewState) @@ -804,7 +804,7 @@ void CFE_TIME_SetState(int16 NewState) * Function: CFE_TIME_SetSource * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_SOURCE == true) @@ -819,7 +819,7 @@ void CFE_TIME_SetSource(int16 NewSource) * Function: CFE_TIME_SetSignal * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_SIGNAL == true) @@ -837,7 +837,7 @@ void CFE_TIME_SetSignal(int16 NewSignal) * Function: CFE_TIME_SetDelay * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_CLIENT == true) @@ -864,7 +864,7 @@ void CFE_TIME_SetDelay(CFE_TIME_SysTime_t NewDelay, int16 Direction) * Function: CFE_TIME_SetTime * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_SERVER == true) @@ -915,7 +915,7 @@ void CFE_TIME_SetTime(CFE_TIME_SysTime_t NewTime) * Function: CFE_TIME_SetMET * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_SERVER == true) @@ -953,7 +953,7 @@ void CFE_TIME_SetMET(CFE_TIME_SysTime_t NewMET) * Function: CFE_TIME_SetSTCF * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_SERVER == true) @@ -979,7 +979,7 @@ void CFE_TIME_SetSTCF(CFE_TIME_SysTime_t NewSTCF) * Function: CFE_TIME_SetLeapSeconds * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_SERVER == true) @@ -1005,7 +1005,7 @@ void CFE_TIME_SetLeapSeconds(int16 NewLeaps) * Function: CFE_TIME_SetAdjust * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_SERVER == true) @@ -1044,7 +1044,7 @@ void CFE_TIME_SetAdjust(CFE_TIME_SysTime_t NewAdjust, int16 Direction) * Function: CFE_TIME_Set1HzAdj * * Application-scope internal function - * See description in cfe_time_utils.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ #if (CFE_PLATFORM_TIME_CFG_SERVER == true) @@ -1063,7 +1063,7 @@ void CFE_TIME_Set1HzAdj(CFE_TIME_SysTime_t NewAdjust, int16 Direction) * Function: CFE_TIME_CleanUpApp * * Implemented per public API - * See description in cfe_time_core_internal.h for argument/return detail + * See description in header file for argument/return detail * *-----------------------------------------------------------------*/ int32 CFE_TIME_CleanUpApp(CFE_ES_AppId_t AppId)