Merge pull request #507 from skliper/fix506-api-doc-scrub

Fix #506 - Update API documentation
nasa · Feb 26, 2020 · f09808f · f09808f
2 parents 56917ac + e403929
commit f09808f
Showing 1 changed file with 33 additions and 3 deletions.
diff --git a/docs/src/main.dox b/docs/src/main.dox
@@ -469,11 +469,12 @@
       <LI> #CFE_ES_ReloadApp - Reload a single cFE Application
       <LI> #CFE_ES_DeleteApp - Delete a single cFE Application
     </UL>
-    <LI> Required Application APIs
+    <LI> Application Behavior APIs
     <UL>
       <LI> #CFE_ES_RegisterApp - Registers a cFE Application with Executive Services
       <LI> #CFE_ES_RunLoop - Checks for Exit, Restart or Reload commands
       <LI> #CFE_ES_WaitForStartupSync - Waits for all Apps in Startup Script to complete initialization
+      <LI> #CFE_ES_WaitForSystemState - Waits for minimum global system state
       <LI> #CFE_ES_IncrementTaskCounter - Increments telemetered task counter to indicate task activity
       <LI> #CFE_ES_ExitApp - Exit for a cFE Application
     </UL>
@@ -503,20 +504,32 @@
     <UL>
       <LI> #CFE_ES_PoolCreate - Initializes a Memory Pool created by an Application
       <LI> #CFE_ES_PoolCreateEx - Initializes a Memory Pool created by an Application with Application specified block sizes
+      <LI> #CFE_ES_PoolCreateNoSem - Initializes a Memory Pool created by an Application without using a semaphore
       <LI> #CFE_ES_GetPoolBuf - Gets a buffer from a Memory Pool
       <LI> #CFE_ES_PutPoolBuf - Releases a buffer to a Memory Pool
       <LI> #CFE_ES_GetMemPoolStats - Extracts statistics maintained by the memory pool software
+      <LI> #CFE_ES_GetPoolBufInfo - Gets info on a buffer previously allocated from a Memory Pool
     </UL>
     <LI> Performance Monitoring APIs
     <UL>
       <LI> #CFE_ES_PerfLogEntry - Marks the entry into a performance analyzer segment of code
       <LI> #CFE_ES_PerfLogExit - Marks the exit from a performance analyzer segment of code
       <LI> #CFE_ES_PerfLogAdd - Adds a mark into the Performance Log
     </UL>
+    <LI> Generic Counter APIs
+    <UL>
+      <LI> #CFE_ES_RegisterGenCounter - Registers a generic counter
+      <LI> #CFE_ES_DeleteGenCounter - Delete previously registered generic counter
+      <LI> #CFE_ES_IncrementGenCounter - Increments the specified generic counter
+      <LI> #CFE_ES_SetGenCount - Set the specified generic counter
+      <LI> #CFE_ES_GetGenCount - Get the specified generic counter count
+      <LI> #CFE_ES_GetGenCounterIDByName - Get the Id associated with a generic counter name
+    </UL>
     <LI> Miscellaneous APIs
     <UL>
       <LI> #CFE_ES_CalculateCRC -  Calculates a CRC on a block of memory
-      <LI> #CFE_ES_WriteToSysLog - Writes a debug message to the System Log
+      <LI> #CFE_ES_WriteToSysLog - Writes a string to the System Log
+      <LI> #CFE_ES_ProcessCoreException - Process an exception detected by the underlying OS/PSP
     </UL>
   </UL>
 
@@ -545,13 +558,15 @@
     <LI> cFE File Header Management APIs
     <UL>
 	  <LI> #CFE_FS_ReadHeader - Read the contents of the Standard cFE File Header
+          <LI> #CFE_FS_InitHeader - Initializes the contents of the Standard cFE File Header
 	  <LI> #CFE_FS_WriteHeader - Write the contents of the Standard cFE File Header
 	  <LI> #CFE_FS_SetTimestamp - Modify the Time Stamp field in the Standard cFE File Header
     </UL>
     <LI> Compressed File Management APIs
     <UL>
 	  <LI> #CFE_FS_IsGzFile - Determines if specified file is a gzip/compressed file
 	  <LI> #CFE_FS_Decompress - Decompresses the specified file to a destination file
+          <LI> #CFE_FS_GetUncompressedFile - Decompresses the source file to a temporary file created in the temp dir
     </UL>
     <LI> Filename Utility APIs
     <UL>
@@ -561,10 +576,12 @@
 
   <H4> Software Bus API </H4>
   <UL>
-    <LI> Pipe Creation/Deletion APIs
+    <LI> Pipe Management APIs
     <UL>
       <LI> #CFE_SB_CreatePipe - Creates a new software bus pipe
       <LI> #CFE_SB_DeletePipe - Deletes a software bus pipe
+      <LI> #CFE_SB_SetPipeOpts - Set options on a pipe
+      <LI> #CFE_SB_GetPipeOpts - Get options on a pipe
     </UL>
     <LI> Message Subscription Control APIs
     <UL>
@@ -577,6 +594,7 @@
     <LI> Send/Receive Message APIs
     <UL>
       <LI> #CFE_SB_SendMsg - Send a software bus message
+      <LI> #CFE_SB_PassMsg - Passes a software bus message not generated by sending application
       <LI> #CFE_SB_RcvMsg - Receive a software bus message
       <LI> #CFE_SB_ZeroCopySend - Send a software bus message in "zero copy" mode
     </UL>
@@ -585,6 +603,7 @@
       <LI> #CFE_SB_ZeroCopyGetPtr - Get a buffer pointer to use for "zero copy" mode
       <LI> #CFE_SB_ZeroCopyReleasePtr - Release an unused "zero copy" mode buffer pointer
       <LI> #CFE_SB_ZeroCopySend - Send a software bus message in "zero copy" mode
+      <LI> #CFE_SB_ZeroCopyPass - Pass an SB message in "zero copy" mode not generated by sending application
     </UL>
     <LI> Setting Message Characteristics APIs
     <UL>
@@ -596,6 +615,7 @@
       <LI> #CFE_SB_TimeStampMsg - Sets the time field in a software bus message with the current spacecraft time
       <LI> #CFE_SB_SetCmdCode - Sets the command code field in a software bus message
       <LI> #CFE_SB_GenerateChecksum - Computes and sets the checksum field in a software bus message
+      <LI> #CFE_SB_MessageStringSet - Copies a string into a software bus message
     </UL>
     <LI> Getting Message Characteristics APIs
     <UL>
@@ -607,13 +627,21 @@
       <LI> #CFE_SB_GetMsgTime - Gets the time field from a software bus message
       <LI> #CFE_SB_GetCmdCode - Gets the command code field from a software bus message
       <LI> #CFE_SB_GetChecksum - Gets the checksum field from a software bus message
+      <LI> #CFE_SB_GetLastSenderId - Gets the application Info of the sender for the last message
+      <LI> CFE_SB_MessageStringGet - Copies a string out of a software bus message
     </UL>
     <LI> Checksum Control APIs
     <UL>
       <LI> #CFE_SB_GenerateChecksum - Computes and sets the checksum field in a software bus message
       <LI> #CFE_SB_GetChecksum - Gets the checksum field from a software bus message
       <LI> #CFE_SB_ValidateChecksum - Validates the checksum of a software bus message
     </UL>
+    <LI> Message ID APIs
+    <UL>
+      <LI> #CFE_SB_MsgId_Equal - Identifies whether a two CFE_SB_MsgId_t values are equal
+      <LI> #CFE_SB_MsgIdToValue - Converts a CFE_SB_MsgId_t to a normal integer
+      <LI> #CFE_SB_ValueToMsgId - Converts a normal integer into a CFE_SB_MsgId_t
+    </UL>
   </UL>
 
   <H4> Table Services API </H4>
@@ -644,6 +672,7 @@
     <UL>
       <LI> #CFE_TBL_GetStatus - Obtain current status of pending actions for a table
       <LI> #CFE_TBL_GetInfo - Obtain characteristics/information about a specific table
+      <LI> #CFE_TBL_NotifyByMessage - Request notification via message when table requires management
     </UL>
   </UL>
 
@@ -691,6 +720,7 @@
     <LI> Miscellaneous Time APIs
     <UL>
       <LI> #CFE_TIME_Print - Converts a time value to a character string
+      <LI> #CFE_TIME_Local1HzISR - Called from the system PSP layer once per second
     </UL>
   </UL>
 **/