Fix #383, resolve explicit link and any remaining misc.

cmake/arch_build.cmake

@@ -347,7 +347,11 @@ function(process_arch SYSVAR)
  "PREDEFINED += ${DOXYGEN_DEFINED_MACROS}\n"
  "INPUT += ${MISSION_SOURCE_DIR}/osal/src/os/${OSAL_SYSTEM_OSTYPE}\n"
  "INPUT += ${MISSION_SOURCE_DIR}/psp/fsw/${CFE_SYSTEM_PSPNAME}\n")
-
+
+ # Append to usersguide.doxyfile
+ file(APPEND "${MISSION_BINARY_DIR}/doc/cfe-usersguide.doxyfile" 
+ "INPUT += ${MISSION_SOURCE_DIR}/psp/fsw/${CFE_SYSTEM_PSPNAME}/src\n")
+
  # The PSP and/or OSAL should have defined where to install the binaries.
  # If not, just install them in /cf as a default (this can be modified 
  # by the packaging script if it is wrong for the target)

cmake/cfe-usersguide.doxyfile.in

@@ -19,6 +19,10 @@ INPUT += @MISSION_SOURCE_DIR@/cfe/cmake/sample_defs
 INPUT += @MISSION_SOURCE_DIR@/cfe/docs/src/main.dox 
 INPUT += @MISSION_SOURCE_DIR@/cfe/docs/src/cfe_usersguide.dox
 
+#PREDEFINED
+PREDEFINED += @USERGUIDE_PREDEFINED@
+
 # Bring in the cFE header files for the documentation of the various API calls
 INPUT += \
-@MISSION_USERGUIDE_HEADERFILES@
+@MISSION_USERGUIDE_HEADERFILES@ \
+@USERGUIDE_MISC_ADDITION@ 

cmake/mission_build.cmake

@@ -222,7 +222,20 @@ function(prepare)
  "${cfe-core_MISSION_DIR}/src/inc/*.h"
  "${osal_MISSION_DIR}/src/os/inc/*.h"
  "${MISSION_SOURCE_DIR}/psp/fsw/inc/*.h")
- string(REPLACE ";" " \\\n" MISSION_USERGUIDE_HEADERFILES "${MISSION_USERGUIDE_HEADERFILES}") 
+ string(REPLACE ";" " \\\n" MISSION_USERGUIDE_HEADERFILES "${MISSION_USERGUIDE_HEADERFILES}") 
+
+ # Addition to usersguide
+ file(GLOB USERGUIDE_MISC_ADDITION
+ "${cfe-core_MISSION_DIR}/src/inc/private/*.h"
+ "${cfe-core_MISSION_DIR}/src/sb/*"
+ "${cfe-core_MISSION_DIR}/src/es/*"
+ "${cfe-core_MISSION_DIR}/src/evs/*")
+ string(REPLACE ";" " \\\n" USERGUIDE_MISC_ADDITION "${USERGUIDE_MISC_ADDITION}")
+
+ # PREDEFINED
+ set(USERGUIDE_PREDEFINED 
+ "MESSAGE_FORMAT_IS_CCSDS")
+
  configure_file("${CMAKE_SOURCE_DIR}/cmake/cfe-usersguide.doxyfile.in"
  "${CMAKE_BINARY_DIR}/doc/cfe-usersguide.doxyfile")
 

docs/src/cfe_es.dox

@@ -262,13 +262,13 @@
  \page cfeesugresetlog Exception and Reset (ER) Log
 
  The Exception and Reset Log contains detailed information about past 
- resets and exceptions. To view the information the #CFE_ES_WRITE_ERLOG_CC 
+ resets and exceptions. To view the information the #CFE_ES_WRITE_ER_LOG_CC 
  command must be sent. This command will write the log to a binary file. 
  The path and filename may be specified in the command. If the filename 
  command field contains an empty string, the configuration parameter 
  #CFE_ES_DEFAULT_ER_LOG_FILE is used to specify the path and filename. 
  Use the ground system to get the file and display the contents. There 
- is also a command to clear the ER log, #CFE_ES_CLEAR_ERLOG_CC.
+ is also a command to clear the ER log, #CFE_ES_CLEAR_ER_LOG_CC.
 
  The size of the ER log is defined by the platform configuration parameter 
  #CFE_ES_ER_LOG_ENTRIES This log is preserved after a processor reset and 
@@ -325,7 +325,7 @@
  the startup script. 
 
  The format of the Start Application command, is defined in the 
- structure #CFE_ES_StartAppCmd_t. The members of the structure 
+ structure #CFE_ES_StartApp_t. The members of the structure 
  include, application name, entry point, filename, stack size, 
  load address, exception action and priority.
 
@@ -653,7 +653,7 @@
 /**
  \page cfeesugperfstart Starting to Collect Performance Data
 
- The #CFE_ES_PERF_STARTDATA_CC command is used to start the data collection
+ The #CFE_ES_START_PERF_DATA_CC command is used to start the data collection
  process. The ES task sends a debug event when the command is received. It is
  not possible to start a collection if the buffer-to-file write is in process
  from an earlier collection. There is an ES telemetry point that can be used to
@@ -671,7 +671,7 @@
 /**
  \page cfeesugperfstop Stopping the Collection of Performance Data
 
- The #CFE_ES_PERF_STOPDATA_CC command is used to stop the data collection 
+ The #CFE_ES_STOP_PERF_DATA_CC command is used to stop the data collection 
  process and write the buffer data to a file. The path and filename may be 
  specified in the command. If the filename command field contains an empty 
  string, the configuration parameter #CFE_ES_DEFAULT_PERF_DUMP_FILENAME is 
@@ -804,7 +804,7 @@
  fail, regardless of whether the created blocks are in-use or not. The margin
  on the memory pool can be monitored by viewing the 'free bytes' member of the
  memory pool statistics. The memory pool statistics are dumped only when
- commanded by way of the ES command #CFE_ES_TLM_POOL_STATS_CC. 
+ commanded by way of the ES command #CFE_ES_SEND_MEM_POOL_STATS_CC. 
 
  A user of the ES memory pool begins by tailoring the memory pool for the
  particular use, by defining a list of block sizes and allocating a block of
@@ -835,7 +835,7 @@
  through the #CFE_ES_PutPoolBuf API, then the memory pool will create a second
  block of that size and return a pointer to the second block. If both blocks
  were then released through the #CFE_ES_PutPoolBuf API and the memory pool
- statistics were dumped via the #CFE_ES_TLM_POOL_STATS_CC command, the number
+ statistics were dumped via the #CFE_ES_SEND_MEM_POOL_STATS_CC command, the number
  of blocks created would be two. The number of 'free bytes' in the pool would
  be the size of the pool minus the sum of the following items: 
  - the size of the two blocks created (even though they are not 'in-use').

docs/src/cfe_sb.dox

@@ -514,7 +514,7 @@
  How is the memory pool handle (sent in SB housekeeping telemetry) intended to be used?
  </B><TR><TD WIDTH="5%"> &nbsp; <TD WIDTH="95%">
  The memory pool handle is used to analyze the SB memory pool statistics. The cFE ES
- command (#CFE_ES_TLM_POOL_STATS_CC) to dump the memory pool statistics takes the pool handle
+ command (#CFE_ES_SEND_MEM_POOL_STATS_CC) to dump the memory pool statistics takes the pool handle
  as a parameter. These statistics tell how the SB memory pool is configured and gives details
  on margin. An improperly configured SB memory pool may inhibit communication. This may occur
  if there is not enough margin to create a block of the size needed for a transfer. Refer to

docs/src/cfe_time.dox

@@ -774,7 +774,7 @@
  to by the other systems.
 
  \sa #CFE_TIME_ADD_ADJUST_CC, #CFE_TIME_SUB_ADJUST_CC, #CFE_TIME_SET_STCF_CC, 
- #CFE_TIME_ADD_1HZADJ_CC, #CFE_TIME_SUB_1HZADJ_CC, #CFE_TIME_SET_LEAPS_CC
+ #CFE_TIME_ADD_1HZ_ADJUSTMENT_CC, #CFE_TIME_SUB_1HZ_ADJUSTMENT_CC, #CFE_TIME_SET_LEAP_SECONDS_CC
 
 
  Next: \ref cfetimeugsetmet <BR>

docs/src/main.dox

@@ -202,7 +202,7 @@
 
  The Major, Minor, and Revision components of the version are provided as simple macros defined in the cfe_version.h
  header file as part of the API definition; these macros must expand to simple integer values, so that they can be used
- in simple #if directives by the macro preprocessor.
+ in simple \#if directives by the macro preprocessor.
 
  The Mission Version is provided as a simple macro defined in the cfe_platform_cfg.h header file. As delivered in
  official releases, these macros must expand to simple integer values, so that they can be used in simple macro
@@ -495,8 +495,8 @@
  </UL>
  <LI> Driver APIs
  <UL>
- <LI> #CFE_ES_RegisterDriver - Registers a Device Driver for a specified device
- <LI> #CFE_ES_UnloadDriver - Removes a Device Driver for a specified device
+ <LI> \#CFE_ES_RegisterDriver - Registers a Device Driver for a specified device
+ <LI> \#CFE_ES_UnloadDriver - Removes a Device Driver for a specified device
  </UL>
  <LI> Critical Data Store APIs
  <UL>

fsw/cfe-core/src/inc/cfe_es.h

@@ -528,8 +528,8 @@ void CFE_ES_ExitApp(uint32 ExitStatus);
 ** \arg #CFE_ES_RunStatus_APP_ERROR - \copydoc CFE_ES_RunStatus_APP_ERROR
 **
 ** \returns
-** \retcode #true \retdesc The application should continue executing \endcode
-** \retcode #false \retdesc The application should terminate itself \endcode
+** \retcode true \retdesc The application should continue executing \endcode
+** \retcode false \retdesc The application should terminate itself \endcode
 ** \endreturns
 **
 ** \sa #CFE_ES_ExitApp, #CFE_ES_RegisterApp

fsw/cfe-core/src/inc/cfe_es_events.h

@@ -959,8 +959,8 @@
 ** This event message is generated in response to receiving an Executive Services
 ** \link #CFE_ES_START_PERF_DATA_CC Start Performance Analyzer Data Collection Command \endlink
 **
-** The \c 'd' field identifies the requested trigger mode. Valid values are #CFE_ES_PerfMode_t CFE_ES_PERF_TRIGGER_START (0),
-** #CFE_ES_PerfMode_t CFE_ES_PERF_TRIGGER_CENTER (1), and #CFE_ES_PerfMode_t CFE_ES_PERF_TRIGGER_END (2)
+** The \c 'd' field identifies the requested trigger mode. Valid values are \link #CFE_ES_PerfMode_t CFE_ES_PERF_TRIGGER_START (0) \endlink,
+** \link #CFE_ES_PerfMode_t CFE_ES_PERF_TRIGGER_CENTER (1) \endlink, and \link #CFE_ES_PerfMode_t CFE_ES_PERF_TRIGGER_END (2) \endlink
 **/
 #define CFE_ES_PERF_STARTCMD_EID 57
 

fsw/cfe-core/src/inc/cfe_es_msg.h

@@ -184,7 +184,7 @@
 ** \cfecmdmnemonic \ES_SHELL
 **
 ** \par Command Structure
-** #CFE_ES_ShellCmd_t
+** #CFE_ES_Shell_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -227,7 +227,7 @@
 ** \cfecmdmnemonic \ES_STARTAPP
 **
 ** \par Command Structure
-** #CFE_ES_StartAppCmd_t
+** #CFE_ES_StartApp_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -370,7 +370,7 @@
 ** \cfecmdmnemonic \ES_RELOADAPP
 **
 ** \par Command Structure
-** #CFE_ES_AppReloadCmd_t
+** #CFE_ES_ReloadApp_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -450,7 +450,7 @@
 ** \cfecmdmnemonic \ES_WRITEAPPINFO2FILE
 **
 ** \par Command Structure
-** #CFE_ES_QueryAllCmd_t
+** #CFE_ES_FileNameCmd_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -530,7 +530,7 @@
 ** \cfecmdmnemonic \ES_WRITESYSLOG2FILE
 **
 ** \par Command Structure
-** #CFE_ES_WriteSyslogCmd_t
+** #CFE_ES_FileNameCmd_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -610,7 +610,7 @@
 ** \cfecmdmnemonic \ES_WRITEERLOG2FILE
 **
 ** \par Command Structure
-** #CFE_ES_WriteERlogCmd_t
+** #CFE_ES_FileNameCmd_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -651,7 +651,7 @@
 ** \cfecmdmnemonic \ES_STARTLADATA
 **
 ** \par Command Structure
-** #CFE_ES_PerfStartCmd_t
+** #CFE_ES_StartPerfData_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -697,7 +697,7 @@
 ** \cfecmdmnemonic \ES_STOPLADATA
 **
 ** \par Command Structure
-** #CFE_ES_PerfStopCmd_t
+** #CFE_ES_StopPerfData_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -740,7 +740,7 @@
 ** \cfecmdmnemonic \ES_LAFILTERMASK
 **
 ** \par Command Structure
-** #CFE_ES_PerfSetFilterMaskCmd_t
+** #CFE_ES_SetPerfFilterMask_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -778,7 +778,7 @@
 ** \cfecmdmnemonic \ES_LATRIGGERMASK
 **
 ** \par Command Structure
-** #CFE_ES_PerfSetTrigMaskCmd_t
+** #CFE_ES_SetPerfTriggerMask_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -818,7 +818,7 @@
 ** \cfecmdmnemonic \ES_OVERWRITESYSLOGMODE
 **
 ** \par Command Structure
-** #CFE_ES_OverWriteSysLogCmd_t
+** #CFE_ES_OverWriteSyslog_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -898,7 +898,7 @@
 ** \cfecmdmnemonic \ES_SETMAXPRCNT
 **
 ** \par Command Structure
-** #CFE_ES_SetMaxPRCountCmd_t
+** #CFE_ES_SetMaxPRCount_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -939,7 +939,7 @@
 ** \cfecmdmnemonic \ES_DELETECDS
 **
 ** \par Command Structure
-** #CFE_ES_DeleteCDSCmd_t
+** #CFE_ES_DeleteCDS_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -982,7 +982,7 @@
 ** \cfecmdmnemonic \ES_TLMPOOLSTATS
 **
 ** \par Command Structure
-** #CFE_ES_TlmPoolStatsCmd_t
+** #CFE_ES_SendMemPoolStats_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -1024,7 +1024,7 @@
 ** \cfecmdmnemonic \ES_DUMPCDSREG
 **
 ** \par Command Structure
-** #CFE_ES_DumpCDSRegCmd_t
+** #CFE_ES_DumpCDSRegistry_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -1065,7 +1065,7 @@
 ** \cfecmdmnemonic \ES_WRITETASKINFO2FILE
 **
 ** \par Command Structure
-** #CFE_ES_QueryAllTasksCmd_t
+** #CFE_ES_FileNameCmd_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 

fsw/cfe-core/src/inc/cfe_evs_events.h

@@ -198,7 +198,7 @@
 ** \par Cause:
 **
 ** This event message is generated when a "Set Event Format Mode" command
-** message has arrived and the #CFE_EVS_ModeCmd_t::Mode field is equal to
+** message has arrived and the #CFE_EVS_SetLogMode_Payload_t::LogMode field is equal to
 ** neither #CFE_EVS_MsgFormat_SHORT or #CFE_EVS_MsgFormat_LONG. These are
 ** the only allowed values for the mode field.
 ** 

fsw/cfe-core/src/inc/cfe_evs_msg.h

@@ -234,7 +234,7 @@
 ** \cfecmdmnemonic \EVS_SETEVTFMT
 **
 ** \par Command Structure
-** #CFE_EVS_ModeCmd_t
+** #CFE_EVS_SetLogMode_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -764,7 +764,7 @@
 ** \cfecmdmnemonic \EVS_WRITEAPPDATA2FILE
 **
 ** \par Command Structure
-** #CFE_EVS_AppDataCmd_t
+** #CFE_EVS_WriteAppDataFile_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -799,7 +799,7 @@
 ** \cfecmdmnemonic \EVS_WRITELOG2FILE
 **
 ** \par Command Structure
-** #CFE_EVS_LogFileCmd_t
+** #CFE_EVS_WriteLogDataFile_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 
@@ -832,7 +832,7 @@
 ** \cfecmdmnemonic \EVS_SETLOGMODE
 **
 ** \par Command Structure
-** #CFE_EVS_ModeCmd_t
+** #CFE_EVS_SetLogMode_t
 **
 ** \par Command Verification
 ** Successful execution of this command may be verified with 

fsw/cfe-core/src/inc/cfe_sb.h

@@ -1298,7 +1298,7 @@ static inline CFE_SB_MsgId_Atom_t CFE_SB_MsgIdToValue(CFE_SB_MsgId_t MsgId)
  * @par Description:
  * In cases where the CFE_SB_MsgId_t type is not a simple integer
  * type, it is not possible to directly use an integer value
- * supplied via a #define or similar method.
+ * supplied via a define or similar method.
  *
  * This inline function provides the ability to map an integer value
  * into a corresponding CFE_SB_MsgId_t value.