Skip to content

Commit

Permalink
Fix #1336, remove specific header names from comments
Browse files Browse the repository at this point in the history
Per CCB review on 2021-04-28, this removes the reference
to a specific header file name in the comment.
  • Loading branch information
jphickey committed Apr 28, 2021
1 parent a355c6f commit a3b8e80
Show file tree
Hide file tree
Showing 48 changed files with 523 additions and 523 deletions.
92 changes: 46 additions & 46 deletions modules/es/fsw/src/cfe_es_api.c

Large diffs are not rendered by default.

30 changes: 15 additions & 15 deletions modules/es/fsw/src/cfe_es_apps.c
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand All @@ -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)
Expand Down
8 changes: 4 additions & 4 deletions modules/es/fsw/src/cfe_es_backgroundtask.c
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand Down
38 changes: 19 additions & 19 deletions modules/es/fsw/src/cfe_es_cds.c
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand All @@ -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)
Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
10 changes: 5 additions & 5 deletions modules/es/fsw/src/cfe_es_cds_mempool.c
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
Loading

0 comments on commit a3b8e80

Please sign in to comment.