Merge pull request #1429 from jphickey/fix-1336-function-comments

Fix #1336, function block comments

modules/core_api/fsw/inc/cfe_es.h

@@ -1449,15 +1449,26 @@ CFE_Status_t CFE_ES_GetMemPoolStats(CFE_ES_MemPoolStats_t *BufPtr, CFE_ES_MemHan
 
 /*****************************************************************************/
 /**
-** \brief Function called by #CFE_ES_PerfLogEntry and #CFE_ES_PerfLogExit macros
+** \brief Adds a new entry to the data buffer
+**
+** Function called by #CFE_ES_PerfLogEntry and #CFE_ES_PerfLogExit macros
 **
 ** \par Description
 **        This function logs the entry and exit marker for the specified
 **        \c id. This function is used by the Software Performance Analysis
 **        tool (see section 5.15).
 **
 ** \par Assumptions, External Events, and Notes:
-**        None
+
+**  This function implements a circular buffer using an array.
+**      DataStart points to first stored entry
+**      DataEnd points to next available entry
+**      if DataStart == DataEnd then the buffer is either empty or full
+**      depending on the value of the DataCount
+**
+**  Time is stored as 2 32 bit integers, (TimerLower32, TimerUpper32):
+**      TimerLower32 is the curent value of the hardware timer register.
+**      TimerUpper32 is the number of times the timer has rolled over.
 **
 ** \param[in]   Marker          Identifier of the specific event or marker.
 ** \param[in]   EntryExit       Used to specify Entry(0) or Exit(1)

modules/core_api/fsw/inc/cfe_fs_core_internal.h

@@ -47,7 +47,7 @@
 ** \brief Initializes the cFE core module API Library
 **
 ** \par Description
-**        Initializes the cFE core module API Library
+**      Initialize the FS data structures before the cFE runs.
 **
 ** \par Assumptions, External Events, and Notes:
 **        -# This function MUST be called before any module API's are called.