Update #411, documentation updates

Correct items flagged as warnings in documenation build, and remove now-unused definition in sample platform config
nasa · May 6, 2020 · 87b87c8 · 87b87c8
1 parent d4f62ed
commit 87b87c8
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 47 deletions.
diff --git a/cmake/sample_defs/cpu1_platform_cfg.h b/cmake/sample_defs/cpu1_platform_cfg.h
@@ -1205,52 +1205,6 @@
 */
 #define CFE_PLATFORM_ES_DEFAULT_STACK_SIZE 8192
 
-/**
-**  \cfeescfg Define cFE Core Exception Function
-**
-**  \par Description:
-**       This parameter defines the function-to-call when a CPU or floating point exception
-**       occurs.  The parameter is defaulted to call the ES API function #CFE_ES_ProcessCoreException
-**       which handles the logging and reset from a system or cFE core exception.
-**
-**       Note: Exception interrupts are trapped at the Platform Support Package (PSP)
-**       layer.  In order to initiate the cFE platform defined response to an exception, this
-**       platform defined callback function must be prototyped and called from the PSP
-**       exception hook API function #CFE_PSP_ExceptionHook. For example:
-**
-**       -- cfe_psp.h --
-**
-**       .... Prototype for exception ISR function implemented in CFE ....
-**
-**       typedef void (*System_ExceptionFunc_t)(uint32  HostTaskId,
-**                                              const char *ReasonString,
-**                                              const uint32 *ContextPointer,
-**                                              uint32 ContextSize);
-**
-**       -- cfe_pspexception.c --
-**
-**       .... Setup function pointer to CFE exception ISR callback ....
-**
-**       static const System_ExceptionFunc_t CFE_ExceptionCallback = CFE_PLATFORM_ES_EXCEPTION_FUNCTION;
-**
-**       void CFE_PSP_ExceptionHook (int task_id, int vector, uint8 *pEsf )
-**       {
-**           .... platform-specific logic ....
-**
-**           .... Use function pointer to call cFE routine to finish processing the exception ....
-**
-**           CFE_ExceptionCallback((uint32)task_id,
-**                                 CFE_PSP_ExceptionReasonString,
-**                                 (uint32 *)&CFE_PSP_ExceptionContext,
-**                                 sizeof(CFE_PSP_ExceptionContext_t));
-**
-**       }
-**
-**  \par Limits
-**       Must be a valid function name.
-*/
-#define CFE_PLATFORM_ES_EXCEPTION_FUNCTION CFE_ES_ProcessCoreException
-
 /**
 **  \cfeescfg Define EVS Task Priority
 **

diff --git a/docs/src/main.dox b/docs/src/main.dox
@@ -472,7 +472,7 @@
     <UL>
       <LI> #CFE_ES_CalculateCRC - \copybrief CFE_ES_CalculateCRC
       <LI> #CFE_ES_WriteToSysLog - \copybrief CFE_ES_WriteToSysLog
-      <LI> #CFE_ES_ProcessCoreException - \copybrief CFE_ES_ProcessCoreException
+      <LI> #CFE_ES_ProcessAsyncEvent - \copybrief CFE_ES_ProcessAsyncEvent
     </UL>
   </UL>