Fix nasa#567, Document CFE_ES_RunLoop increment task counter behavior

jphickey · Jun 3, 2021 · 11776a3 · 11776a3
1 parent 176e3df
commit 11776a3
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/modules/core_api/fsw/inc/cfe_es.h b/modules/core_api/fsw/inc/cfe_es.h
@@ -355,7 +355,9 @@ void CFE_ES_ExitApp(uint32 ExitStatus);
 **         the system.
 **
 ** \par Assumptions, External Events, and Notes:
-**          None
+**        This API updates the internal task counter tracked by ES for the calling task.
+**        For ES to report application counters correctly this API should be called
+**        from the main app task as part of it's main processing loop.
 **
 ** \param[in]  RunStatus    A pointer to a variable containing the Application's
 **                          desired run status.  Acceptable values are: