Partial #1474, Resolved API function/prototype mismatches

modules/core_api/fsw/inc/cfe_es.h

@@ -112,14 +112,14 @@ CFE_Status_t CFE_ES_AppID_ToIndex(CFE_ES_AppId_t AppID, uint32 *Idx);
  * back to the original LibID value.  The caller should retain the original ID
  * for future use.
  *
- * @param[in]   LibID  Library ID to convert
+ * @param[in]   LibId  Library ID to convert
  * @param[out]  Idx    Buffer where the calculated index will be stored
  *
  * @return Execution status, see @ref CFEReturnCodes
  * @retval #CFE_SUCCESS                      @copybrief CFE_SUCCESS
  * @retval #CFE_ES_ERR_RESOURCEID_NOT_VALID  @copybrief CFE_ES_ERR_RESOURCEID_NOT_VALID
  */
-int32 CFE_ES_LibID_ToIndex(CFE_ES_LibId_t LibID, uint32 *Idx);
+int32 CFE_ES_LibID_ToIndex(CFE_ES_LibId_t LibId, uint32 *Idx);
 
 /**
  * @brief Obtain an index value correlating to an ES Task ID
@@ -162,14 +162,14 @@ CFE_Status_t CFE_ES_TaskID_ToIndex(CFE_ES_TaskId_t TaskID, uint32 *Idx);
  * back to the original CounterID value.  The caller should retain the original ID
  * for future use.
  *
- * @param[in]   CounterID  Counter ID to convert
+ * @param[in]   CounterId  Counter ID to convert
  * @param[out]  Idx     Buffer where the calculated index will be stored
  *
  * @return Execution status, see @ref CFEReturnCodes
  * @retval #CFE_SUCCESS                      @copybrief CFE_SUCCESS
  * @retval #CFE_ES_ERR_RESOURCEID_NOT_VALID  @copybrief CFE_ES_ERR_RESOURCEID_NOT_VALID
  */
-CFE_Status_t CFE_ES_CounterID_ToIndex(CFE_ES_CounterId_t CounterID, uint32 *Idx);
+CFE_Status_t CFE_ES_CounterID_ToIndex(CFE_ES_CounterId_t CounterId, uint32 *Idx);
 
 /** @} */
 
@@ -357,7 +357,7 @@ void CFE_ES_ExitApp(uint32 ExitStatus);
 ** \par Assumptions, External Events, and Notes:
 **          None
 **
-** \param[in]  ExitStatus   A pointer to a variable containing the Application's
+** \param[in]  RunStatus    A pointer to a variable containing the Application's
 **                          desired run status.  Acceptable values are:
 **                          \arg #CFE_ES_RunStatus_APP_RUN - \copybrief CFE_ES_RunStatus_APP_RUN
 **                          \arg #CFE_ES_RunStatus_APP_EXIT - \copybrief CFE_ES_RunStatus_APP_EXIT
@@ -370,7 +370,7 @@ void CFE_ES_ExitApp(uint32 ExitStatus);
 ** \sa #CFE_ES_ExitApp
 **
 ******************************************************************************/
-bool CFE_ES_RunLoop(uint32 *ExitStatus);
+bool CFE_ES_RunLoop(uint32 *RunStatus);
 
 /*****************************************************************************/
 /**
@@ -1029,9 +1029,9 @@ void CFE_ES_ProcessAsyncEvent(void);
 **        This is indicated by a #CFE_SUCCESS return code, and in this case the calling application should
 **        ensure that it also calls CFE_ES_CopyToCDS() to fill the block with valid data.
 **
-** \param[in, out]   HandlePtr   Pointer Application's variable that will contain the CDS Memory Block Handle.
-**                               HandlePtr is the handle of the CDS block that can be used in
-**                               #CFE_ES_CopyToCDS and #CFE_ES_RestoreFromCDS.
+** \param[in, out]   CDSHandlePtr   Pointer Application's variable that will contain the CDS Memory Block Handle.
+**                                  HandlePtr is the handle of the CDS block that can be used in
+**                                  #CFE_ES_CopyToCDS and #CFE_ES_RestoreFromCDS.
 **
 ** \param[in]   BlockSize   The number of bytes needed in the CDS.
 **
@@ -1050,7 +1050,7 @@ void CFE_ES_ProcessAsyncEvent(void);
 ** \sa #CFE_ES_CopyToCDS, #CFE_ES_RestoreFromCDS
 **
 ******************************************************************************/
-CFE_Status_t CFE_ES_RegisterCDS(CFE_ES_CDSHandle_t *HandlePtr, size_t BlockSize, const char *Name);
+CFE_Status_t CFE_ES_RegisterCDS(CFE_ES_CDSHandle_t *CDSHandlePtr, size_t BlockSize, const char *Name);
 
 /*****************************************************************************/
 /**
@@ -1311,7 +1311,7 @@ int32 CFE_ES_PoolDelete(CFE_ES_MemHandle_t PoolID);
 ** \param[in, out]   BufPtr      A pointer to the Application's pointer in which will be stored the address of the
 **                               allocated memory buffer. *BufPtr is the address of the requested buffer.
 **
-** \param[in]   PoolID   The handle to the memory pool as returned by #CFE_ES_PoolCreate or #CFE_ES_PoolCreateNoSem.
+** \param[in]   Handle      The handle to the memory pool as returned by #CFE_ES_PoolCreate or #CFE_ES_PoolCreateNoSem.
 **
 ** \param[in]   Size        The size of the buffer requested.  NOTE: The size allocated may be larger.
 **
@@ -1324,7 +1324,7 @@ int32 CFE_ES_PoolDelete(CFE_ES_MemHandle_t PoolID);
 *#CFE_ES_GetPoolBufInfo
 **
 ******************************************************************************/
-int32 CFE_ES_GetPoolBuf(CFE_ES_MemPoolBuf_t *BufPtr, CFE_ES_MemHandle_t PoolID, size_t Size);
+int32 CFE_ES_GetPoolBuf(CFE_ES_MemPoolBuf_t *BufPtr, CFE_ES_MemHandle_t Handle, size_t Size);
 
 /*****************************************************************************/
 /**
@@ -1336,9 +1336,9 @@ int32 CFE_ES_GetPoolBuf(CFE_ES_MemPoolBuf_t *BufPtr, CFE_ES_MemHandle_t PoolID,
 ** \par Assumptions, External Events, and Notes:
 **        None
 **
-** \param[in]   PoolID   The handle to the memory pool as returned by #CFE_ES_PoolCreate or #CFE_ES_PoolCreateNoSem.
+** \param[in]   Handle  The handle to the memory pool as returned by #CFE_ES_PoolCreate or #CFE_ES_PoolCreateNoSem.
 **
-** \param[in]   BufPtr      A pointer to the memory buffer to provide status for.
+** \param[in]   BufPtr  A pointer to the memory buffer to provide status for.
 **
 ** \return Execution status, see \ref CFEReturnCodes
 ** \retval #CFE_SUCCESS                       \copybrief CFE_SUCCESS
@@ -1350,7 +1350,7 @@ int32 CFE_ES_GetPoolBuf(CFE_ES_MemPoolBuf_t *BufPtr, CFE_ES_MemHandle_t PoolID,
 *#CFE_ES_PutPoolBuf
 **
 ******************************************************************************/
-CFE_Status_t CFE_ES_GetPoolBufInfo(CFE_ES_MemHandle_t PoolID, CFE_ES_MemPoolBuf_t BufPtr);
+CFE_Status_t CFE_ES_GetPoolBufInfo(CFE_ES_MemHandle_t Handle, CFE_ES_MemPoolBuf_t BufPtr);
 
 /*****************************************************************************/
 /**
@@ -1362,9 +1362,9 @@ CFE_Status_t CFE_ES_GetPoolBufInfo(CFE_ES_MemHandle_t PoolID, CFE_ES_MemPoolBuf_
 ** \par Assumptions, External Events, and Notes:
 **        None
 **
-** \param[in]   PoolID   The handle to the memory pool as returned by #CFE_ES_PoolCreate or #CFE_ES_PoolCreateNoSem.
+** \param[in]   Handle The handle to the memory pool as returned by #CFE_ES_PoolCreate or #CFE_ES_PoolCreateNoSem.
 **
-** \param[in]   BufPtr      A pointer to the memory buffer to be released.
+** \param[in]   BufPtr A pointer to the memory buffer to be released.
 **
 ** \return Bytes released, or error code \ref CFEReturnCodes
 ** \retval #CFE_ES_ERR_RESOURCEID_NOT_VALID  \copybrief CFE_ES_ERR_RESOURCEID_NOT_VALID
@@ -1374,7 +1374,7 @@ CFE_Status_t CFE_ES_GetPoolBufInfo(CFE_ES_MemHandle_t PoolID, CFE_ES_MemPoolBuf_
 *#CFE_ES_GetPoolBufInfo
 **
 ******************************************************************************/
-int32 CFE_ES_PutPoolBuf(CFE_ES_MemHandle_t PoolID, CFE_ES_MemPoolBuf_t BufPtr);
+int32 CFE_ES_PutPoolBuf(CFE_ES_MemHandle_t Handle, CFE_ES_MemPoolBuf_t BufPtr);
 
 /*****************************************************************************/
 /**

modules/core_api/fsw/inc/cfe_evs.h

@@ -89,9 +89,9 @@
 **                               The structure of an event message filter depends on the FilterScheme selected.
 **                               (see Filter Schemes mentioned above)
 **
-** \param[in] NumFilteredEvents  The number of event message filters included in this call.  This must be less than
+** \param[in] NumEventFilters    The number of event message filters included in this call.  This must be less than
 **                               or equal to the maximum number of events allowed per application
-*(#CFE_PLATFORM_EVS_MAX_EVENT_FILTERS).
+**                               (#CFE_PLATFORM_EVS_MAX_EVENT_FILTERS).
 **
 ** \param[in] FilterScheme       The event filtering scheme that this application will use.  For the first
 **                               implementation of the event services, only filter type #CFE_EVS_EventFilter_BINARY
@@ -106,9 +106,7 @@
 ** \sa #CFE_EVS_Unregister
 **
 **/
-CFE_Status_t CFE_EVS_Register(const void *Filters,           /* Pointer to an array of filters */
-                              uint16      NumFilteredEvents, /* How many elements in the array? */
-                              uint16      FilterScheme);          /* Filtering Algorithm to be implemented */
+CFE_Status_t CFE_EVS_Register(const void *Filters, uint16 NumEventFilters, uint16 FilterScheme);
 
 /**
 ** \brief Cleanup internal structures used by the event manager for the calling Application.

modules/core_api/fsw/inc/cfe_msg.h

@@ -591,15 +591,15 @@ CFE_Status_t CFE_MSG_GetMsgTime(const CFE_MSG_Message_t *MsgPtr, CFE_TIME_SysTim
  *          - Note default implementation of command messages do not have a time field.
  *
  * \param[in, out]  MsgPtr      A pointer to the message.
- * \param[in]       Time        The time to include in the message.  This will usually be a time
+ * \param[in]       NewTime     The time to include in the message.  This will usually be a time
  *                              from #CFE_TIME_GetTime.
  *
  * \return Execution status, see \ref CFEReturnCodes
  * \retval #CFE_SUCCESS            \copybrief CFE_SUCCESS
  * \retval #CFE_MSG_BAD_ARGUMENT   \copybrief CFE_MSG_BAD_ARGUMENT
  * \retval #CFE_MSG_WRONG_MSG_TYPE \copybrief CFE_MSG_WRONG_MSG_TYPE
  */
-CFE_Status_t CFE_MSG_SetMsgTime(CFE_MSG_Message_t *MsgPtr, CFE_TIME_SysTime_t Time);
+CFE_Status_t CFE_MSG_SetMsgTime(CFE_MSG_Message_t *MsgPtr, CFE_TIME_SysTime_t NewTime);
 
 /**\}*/
 

modules/core_api/fsw/inc/cfe_resourceid.h

@@ -203,7 +203,7 @@ uint32 CFE_ResourceId_GetSerial(CFE_ResourceId_t ResourceId);
  *
  */
 CFE_ResourceId_t CFE_ResourceId_FindNext(CFE_ResourceId_t StartId, uint32 TableSize,
-                                                bool (*CheckFunc)(CFE_ResourceId_t));
+                                         bool (*CheckFunc)(CFE_ResourceId_t));
 
 /**
  * @brief Internal routine to aid in converting an ES resource ID to an array index

modules/core_api/fsw/inc/cfe_sb.h

@@ -173,15 +173,15 @@ CFE_Status_t CFE_SB_SetPipeOpts(CFE_SB_PipeId_t PipeId, uint8 Opts);
 **
 ** \param[in]  PipeId       The pipe ID of the pipe to get options from.
 **
-** \param[out] *OptPtr      A bit field of options.
+** \param[out] *OptsPtr     A bit field of options.
 **
 ** \return Execution status, see \ref CFEReturnCodes
 ** \retval #CFE_SUCCESS         \copybrief CFE_SUCCESS
 ** \retval #CFE_SB_BAD_ARGUMENT \copybrief CFE_SB_BAD_ARGUMENT
 **
 ** \sa #CFE_SB_CreatePipe #CFE_SB_DeletePipe #CFE_SB_SetPipeOpts #CFE_SB_GetPipeIdByName #CFE_SB_PIPEOPTS_IGNOREMINE
 **/
-CFE_Status_t CFE_SB_GetPipeOpts(CFE_SB_PipeId_t PipeId, uint8 *OptPtr);
+CFE_Status_t CFE_SB_GetPipeOpts(CFE_SB_PipeId_t PipeId, uint8 *OptsPtr);
 
 /*****************************************************************************/
 /**

modules/core_api/fsw/inc/cfe_tbl.h

@@ -183,11 +183,8 @@
 **
 ** \sa #CFE_TBL_Unregister, #CFE_TBL_Share
 **/
-CFE_Status_t CFE_TBL_Register(CFE_TBL_Handle_t *        TblHandlePtr,          /* Returned Handle */
-                              const char *              Name,                  /* Application specific name  */
-                              size_t                    Size,                  /* Size, in bytes, of table   */
-                              uint16                    TblOptionFlags,        /* Tbl Options Settings     */
-                              CFE_TBL_CallbackFuncPtr_t TblValidationFuncPtr); /* Ptr to func that validates tbl */
+CFE_Status_t CFE_TBL_Register(CFE_TBL_Handle_t *TblHandlePtr, const char *Name, size_t Size, uint16 TblOptionFlags,
+                              CFE_TBL_CallbackFuncPtr_t TblValidationFuncPtr);
 
 /*****************************************************************************/
 /**