diff --git a/Apache_2_0_license_for_GSC-18450-1.pdf b/Apache_2_0_license_for_GSC-18450-1_ver_2_3_3.pdf
similarity index 85%
rename from Apache_2_0_license_for_GSC-18450-1.pdf
rename to Apache_2_0_license_for_GSC-18450-1_ver_2_3_3.pdf
index a0fbeda..3c5edbd 100644
Binary files a/Apache_2_0_license_for_GSC-18450-1.pdf and b/Apache_2_0_license_for_GSC-18450-1_ver_2_3_3.pdf differ
diff --git a/LICENSE b/LICENSE
index 261eeb9..3c5edbd 100644
Binary files a/LICENSE and b/LICENSE differ
diff --git a/README.md b/README.md
index 1f9d98b..f23d915 100644
--- a/README.md
+++ b/README.md
@@ -4,10 +4,10 @@ core Flight System (cFS) Memory Dwell Application (MD)
Open Source Release Readme
==========================
-MD Release 2.3.2
+MD Release 2.3.3
Date:
-4/1/2020
+10/7/2020
Introduction
-------------
@@ -29,7 +29,7 @@ Introduction
Software Included
------------------
- Memory Dwell application (MD) 2.3.2
+ Memory Dwell application (MD) 2.3.3
Software Required
diff --git a/docs/MD_v2.3.3_VersionDescriptionDocument.pdf b/docs/MD_v2.3.3_VersionDescriptionDocument.pdf
new file mode 100644
index 0000000..9616650
Binary files /dev/null and b/docs/MD_v2.3.3_VersionDescriptionDocument.pdf differ
diff --git a/docs/dox_src/users_guide/cfs_md.dox b/docs/dox_src/users_guide/cfs_md.dox
index 799ebb0..97b7c99 100644
--- a/docs/dox_src/users_guide/cfs_md.dox
+++ b/docs/dox_src/users_guide/cfs_md.dox
@@ -36,6 +36,8 @@
Member added to project c:/MKSDATA/MKS-REPOSITORY/CFS-REPOSITORY/md/docs/dox_src/users_guide/project.pj
\endverbatim
+ Next: \ref cfsmdintro
+
**/
/**
@@ -106,7 +108,9 @@
UTC Universal time code
- Next: \ref cfsmdovr
+ Next: \ref cfsmdovr
+ Prev: \ref cfsmdrevhist
+
**/
/**
@@ -138,7 +142,8 @@
information for each Memory Dwell included in Table Loads is saved to the CDS. Enabled/disabled
state information set by commands is not saved to the CDS.
- Next: \ref cfsmdopr
+ Next: \ref cfsmdopr
+ Pref: \ref cfsmdintro
**/
/**
@@ -243,6 +248,9 @@
/**
\page cfsmdcmds CFS Memory Dwell Commands
+
+ Next: \ref cfsmdtlm
+ Prev: \ref cfsmddg
\ref cfsmdtlm
@@ -255,12 +263,15 @@
/**
\page cfsmdtlm CFS Memory Dwell Telemetry
+
+ Next: \ref cfsmdtbl
+ Prev: \ref cfsmdcmds
-
- \ref cfsmdcmds
- \ref cfsmdtbl
- \ref cfsmdcfg
-
+
+ \ref cfsmdcmds
+ \ref cfsmdtbl
+ \ref cfsmdcfg
+
The Memory Dwell Application sends the following telemetry to the ground:
**/
@@ -268,11 +279,14 @@
/**
\page cfsmdtbl CFS Memory Dwell Table Definitions
-
- \ref cfsmdcmds
- \ref cfsmdtlm
- \ref cfsmdcfg
-
+ Next: \ref cfsmdcfg
+ Prev: \ref cfsmdtlm
+
+
+ \ref cfsmdcmds
+ \ref cfsmdtlm
+ \ref cfsmdcfg
+
The Memory Dwell Application uses one type of table, a Memory Dwell Load Table. One table is used for
each dwell stream that MD is configured to manage. The #MD_NUM_DWELL_TABLES configuration parameter
@@ -304,14 +318,17 @@
/**
\page cfsmdcfg CFS Memory Dwell Configuration Parameters
-
- \ref cfsmdcmds
- \ref cfsmdtlm
- \ref cfsmdtbl
-
+ Next: \ref cfsmdcons
+ Prev: \ref cfsmdtbl
+
+
+ \ref cfsmdcmds
+ \ref cfsmdtlm
+ \ref cfsmdtbl
+
- The following are configuration parameters used to configure the CFS Memory Dwell
- Application either for each platform or for a mission as a whole.
+ The following are configuration parameters used to configure the CFS Memory Dwell
+ Application either for each platform or for a mission as a whole.
**/
@@ -332,8 +349,8 @@
If a pipe read error is encountered from the CFE Software Bus,
the Memory Dwell task will send an error message and then terminate.
- Next: \ref cfsmdfaqs
- Prev: \ref cfsmdtbl
+ Next: \ref cfsmdfaqs
+ Prev: \ref cfsmdcfg
**/
/**
diff --git a/fsw/mission_inc/md_perfids.h b/fsw/mission_inc/md_perfids.h
index 8f30122..e159f56 100644
--- a/fsw/mission_inc/md_perfids.h
+++ b/fsw/mission_inc/md_perfids.h
@@ -2,7 +2,7 @@
** File: md_perfids.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/platform_inc/md_msgids.h b/fsw/platform_inc/md_msgids.h
index c5cb91d..988b6cd 100644
--- a/fsw/platform_inc/md_msgids.h
+++ b/fsw/platform_inc/md_msgids.h
@@ -2,7 +2,7 @@
** File: md_msgids.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/platform_inc/md_platform_cfg.h b/fsw/platform_inc/md_platform_cfg.h
index da5e4e5..a70cdf9 100644
--- a/fsw/platform_inc/md_platform_cfg.h
+++ b/fsw/platform_inc/md_platform_cfg.h
@@ -2,7 +2,7 @@
** File: md_platform_cfg.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
@@ -53,7 +53,7 @@
** This string shouldn't be longer than #OS_MAX_PATH_LEN for the
** target platform in question
*/
-#define MD_TBL_FILENAME_FORMAT "/cf/md_dw\%02d.tbl"
+#define MD_TBL_FILENAME_FORMAT "/cf/md_dw%02d.tbl"
/**
** \mdcfg Number of memory dwell tables.
diff --git a/fsw/src/md_app.c b/fsw/src/md_app.c
index 7e9de88..e66def4 100644
--- a/fsw/src/md_app.c
+++ b/fsw/src/md_app.c
@@ -2,7 +2,7 @@
** File: md_app.c
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
@@ -59,7 +59,7 @@ void MD_AppMain ( void )
CFE_SB_MsgId_t MessageID;
int32 Status = CFE_SUCCESS;
uint8 TblIndex = 0;
- boolean IsRegistered = FALSE;
+ bool IsRegistered = false;
/*
** Register the Application with Executive Services
@@ -67,15 +67,15 @@ void MD_AppMain ( void )
Status = CFE_ES_RegisterApp();
if(Status != CFE_SUCCESS)
{
- IsRegistered = FALSE;
+ IsRegistered = false;
CFE_ES_WriteToSysLog
- ("MD_APP: Call to CFE_ES_RegisterApp Failed:RC=0x%08X\n",(unsigned int)Status);
- MD_AppData.RunStatus = CFE_ES_APP_ERROR;
+ ("MD_APP: Call to CFE_ES_RegisterApp Failed:RC=%d\n", Status);
+ MD_AppData.RunStatus = CFE_ES_RunStatus_APP_ERROR;
}/* end if */
else
{ /* Successfully registered */
- IsRegistered = TRUE;
- MD_AppData.RunStatus = CFE_ES_APP_RUN;
+ IsRegistered = true;
+ MD_AppData.RunStatus = CFE_ES_RunStatus_APP_RUN;
/* Create the first Performance Log entry */
CFE_ES_PerfLogEntry(MD_APPMAIN_PERF_ID);
@@ -85,14 +85,14 @@ void MD_AppMain ( void )
if (Status != CFE_SUCCESS)
{
- CFE_ES_WriteToSysLog("MD:Application Init Failed,RC=0x%08X\n", (unsigned int)Status);
- MD_AppData.RunStatus = CFE_ES_APP_ERROR;
+ CFE_ES_WriteToSysLog("MD:Application Init Failed,RC=%d\n", Status);
+ MD_AppData.RunStatus = CFE_ES_RunStatus_APP_ERROR;
}
}
/* Loop Forever, or until ES exit command, or SB error */
- while ( CFE_ES_RunLoop(&MD_AppData.RunStatus) == TRUE)
+ while ( CFE_ES_RunLoop(&MD_AppData.RunStatus) == true)
{
/* Copy any newly loaded tables */
for (TblIndex=0; TblIndex < MD_NUM_DWELL_TABLES; TblIndex++)
@@ -112,10 +112,10 @@ void MD_AppMain ( void )
/*
** Exit on pipe read error
*/
- CFE_EVS_SendEvent(MD_PIPE_ERR_EID, CFE_EVS_ERROR,
- "SB Pipe Read Error, App will exit. Pipe Return Status = 0x%08X", (unsigned int)Status);
+ CFE_EVS_SendEvent(MD_PIPE_ERR_EID, CFE_EVS_EventType_ERROR,
+ "SB Pipe Read Error, App will exit. Pipe Return Status = %d", Status);
- MD_AppData.RunStatus = CFE_ES_APP_ERROR;
+ MD_AppData.RunStatus = CFE_ES_RunStatus_APP_ERROR;
}
@@ -132,10 +132,10 @@ void MD_AppMain ( void )
if (CFE_SB_GetTotalMsgLength(MD_AppData.MsgPtr) != sizeof(MD_NoArgsCmd_t))
{
- CFE_EVS_SendEvent( MD_MSG_LEN_ERR_EID, CFE_EVS_ERROR,
- "Msg with Bad length Rcvd: ID = 0x%04X, Exp Len = %d, Len = %d",
+ CFE_EVS_SendEvent( MD_MSG_LEN_ERR_EID, CFE_EVS_EventType_ERROR,
+ "Msg with Bad length Rcvd: ID = 0x%04X, Exp Len = %u, Len = %d",
MessageID,
- sizeof(MD_NoArgsCmd_t),
+ (unsigned int) sizeof(MD_NoArgsCmd_t),
CFE_SB_GetTotalMsgLength(MD_AppData.MsgPtr));
}
else
@@ -153,10 +153,10 @@ void MD_AppMain ( void )
if (CFE_SB_GetTotalMsgLength(MD_AppData.MsgPtr) != sizeof(MD_NoArgsCmd_t))
{
- CFE_EVS_SendEvent( MD_MSG_LEN_ERR_EID, CFE_EVS_ERROR,
- "Msg with Bad length Rcvd: ID = 0x%04X, Exp Len = %d, Len = %d",
+ CFE_EVS_SendEvent( MD_MSG_LEN_ERR_EID, CFE_EVS_EventType_ERROR,
+ "Msg with Bad length Rcvd: ID = 0x%04X, Exp Len = %u, Len = %d",
MessageID,
- sizeof(MD_NoArgsCmd_t),
+ (unsigned int)sizeof(MD_NoArgsCmd_t),
CFE_SB_GetTotalMsgLength(MD_AppData.MsgPtr));
}
else
@@ -166,7 +166,7 @@ void MD_AppMain ( void )
break;
default:
- CFE_EVS_SendEvent(MD_MID_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_MID_ERR_EID, CFE_EVS_EventType_ERROR,
"Msg with Invalid message ID Rcvd -- ID = 0x%04X",
MessageID );
break;
@@ -180,7 +180,7 @@ void MD_AppMain ( void )
/*
** Performance Log Exit Stamp.
*/
- if (IsRegistered == TRUE)
+ if (IsRegistered == true)
{
CFE_ES_PerfLogExit(MD_APPMAIN_PERF_ID);
}
@@ -212,7 +212,7 @@ int32 MD_AppInit( void )
if(Status != CFE_SUCCESS)
{
CFE_ES_WriteToSysLog
- ("MD_APP:Call to CFE_EVS_Register Failed:RC=0x%08X\n", (unsigned int)Status);
+ ("MD_APP:Call to CFE_EVS_Register Failed:RC=%d\n", Status);
}/* end if */
/*
@@ -237,7 +237,7 @@ int32 MD_AppInit( void )
*/
if(Status == CFE_SUCCESS)
{
- Status = CFE_EVS_SendEvent (MD_INIT_INF_EID, CFE_EVS_INFORMATION,
+ Status = CFE_EVS_SendEvent (MD_INIT_INF_EID, CFE_EVS_EventType_INFORMATION,
"MD Initialized. Version %d.%d.%d.%d",
MD_MAJOR_VERSION,
MD_MINOR_VERSION,
@@ -254,7 +254,7 @@ int32 MD_AppInit( void )
/******************************************************************************/
void MD_InitControlStructures(void)
{
- uint16 TblIndex = 0;
+ uint16 TblIndex;
MD_DwellPacketControl_t *DwellControlPtr = NULL;
for (TblIndex=0; TblIndex < MD_NUM_DWELL_TABLES; TblIndex++)
@@ -279,12 +279,12 @@ void MD_InitControlStructures(void)
int32 MD_InitSoftwareBusServices( void )
{
int32 Status = CFE_SUCCESS;
- uint16 TblIndex = 0;
+ uint16 TblIndex;
/*
** Initialize housekeeping telemetry packet (clear user data area)
*/
- CFE_SB_InitMsg(&MD_AppData.HkPkt, MD_HK_TLM_MID, MD_HK_TLM_LNGTH, TRUE);
+ CFE_SB_InitMsg(&MD_AppData.HkPkt, MD_HK_TLM_MID, MD_HK_TLM_LNGTH, true);
/*
** Initialize dwell packets (clear user data area)
@@ -294,7 +294,7 @@ int32 MD_InitSoftwareBusServices( void )
CFE_SB_InitMsg(&MD_AppData.MD_DwellPkt[TblIndex],
(CFE_SB_MsgId_t) MD_DWELL_PKT_MID_BASE + TblIndex,
MD_DWELL_PKT_LNGTH, /* this is max pkt size */
- TRUE); /* clear data area and set seq count to zero. */
+ true); /* clear data area and set seq count to zero. */
#if MD_SIGNATURE_OPTION == 1
MD_AppData.MD_DwellPkt[TblIndex].Signature[0]='\0';
@@ -309,8 +309,8 @@ int32 MD_InitSoftwareBusServices( void )
if(Status != CFE_SUCCESS)
{
- CFE_ES_WriteToSysLog("MD_APP: Error creating cmd pipe:RC=0x%08X\n",
- (unsigned int)Status);
+ CFE_EVS_SendEvent(MD_CREATE_PIPE_ERR_EID, CFE_EVS_EventType_ERROR,
+ "Failed to create pipe. RC = %d", Status);
}/* end if */
@@ -324,9 +324,9 @@ int32 MD_InitSoftwareBusServices( void )
if(Status != CFE_SUCCESS)
{
- CFE_ES_WriteToSysLog
- ("MD_APP: Error subscribing to HK Request:RC=0x%08X\n",
- (unsigned int)Status);
+ CFE_EVS_SendEvent(MD_SUB_HK_ERR_EID, CFE_EVS_EventType_ERROR,
+ "Failed to subscribe to HK requests RC = %d",
+ Status);
}/* end if */
}/* end if */
@@ -342,9 +342,9 @@ int32 MD_InitSoftwareBusServices( void )
if(Status != CFE_SUCCESS)
{
- CFE_ES_WriteToSysLog
- ("MD_APP:Error subscribing to gnd cmds:RC=0x%08X\n",
- (unsigned int)Status);
+ CFE_EVS_SendEvent(MD_SUB_CMD_ERR_EID, CFE_EVS_EventType_ERROR,
+ "Failed to subscribe to commands. RC = %d",
+ Status);
}/* end if */
}/* end if */
@@ -360,9 +360,9 @@ int32 MD_InitSoftwareBusServices( void )
if(Status != CFE_SUCCESS)
{
- CFE_ES_WriteToSysLog
- ("MD_APP:Error subscribing to wakeup message:RC=0x%08X\n",
- (unsigned int)Status);
+ CFE_EVS_SendEvent(MD_SUB_WAKEUP_ERR_EID, CFE_EVS_EventType_ERROR,
+ "Failed to subscribe to wakeup messages. RC = %d",
+ Status);
}/* end if */
}/* end if */
@@ -378,9 +378,9 @@ int32 MD_InitTableServices( void )
{
int32 Status = CFE_SUCCESS;
int32 GetAddressResult = 0;
- uint8 TblIndex = 0;
- boolean RecoveredValidTable = TRUE; /* for current table */
- boolean TableInitValidFlag = TRUE; /* for all tables so far*/
+ uint8 TblIndex;
+ bool RecoveredValidTable = true; /* for current table */
+ bool TableInitValidFlag = true; /* for all tables so far*/
MD_DwellTableLoad_t InitMemDwellTable;
MD_DwellTableLoad_t* MD_LoadTablePtr = NULL;
uint16 TblRecos = 0; /* Number of Tables Recovered */
@@ -397,10 +397,10 @@ int32 MD_InitTableServices( void )
*/
for ( TblIndex = 0;
- (TblIndex < MD_NUM_DWELL_TABLES) && (TableInitValidFlag == TRUE);
+ (TblIndex < MD_NUM_DWELL_TABLES) && (TableInitValidFlag == true);
TblIndex++)
{
- RecoveredValidTable = FALSE;
+ RecoveredValidTable = false;
/* Prepare Table Name */
Status = snprintf(MD_AppData.MD_TableName[TblIndex],
@@ -409,31 +409,33 @@ int32 MD_InitTableServices( void )
if(Status < 0)
{
CFE_EVS_SendEvent(MD_INIT_TBL_NAME_ERR_EID,
- CFE_EVS_ERROR,
+ CFE_EVS_EventType_ERROR,
"TableName could not be made. Err=0x%08X, Idx=%d",
Status,
TblIndex);
- TableInitValidFlag = FALSE;
+ TableInitValidFlag = false;
/* Advance to the next index */
continue;
}
+
+ /* allows total of CFE_TBL_MAX_NAME_LENGTH characters to be copied */
Status = snprintf(TblFileName,
- OS_MAX_PATH_LEN, /* allows total of CFE_TBL_MAX_NAME_LENGTH characters to be copied */
+ OS_MAX_PATH_LEN,
MD_TBL_FILENAME_FORMAT, TblIndex + 1);
if(Status < 0)
{
CFE_EVS_SendEvent(MD_INIT_TBL_FILENAME_ERR_EID,
- CFE_EVS_ERROR,
+ CFE_EVS_EventType_ERROR,
"TblFileName could not be made. Err=0x%08X, Idx=%d",
Status,
TblIndex);
- TableInitValidFlag = FALSE;
+ TableInitValidFlag = false;
/* Advance to the next index */
continue;
@@ -457,7 +459,7 @@ int32 MD_InitTableServices( void )
if(GetAddressResult != CFE_TBL_INFO_UPDATED)
{
- CFE_EVS_SendEvent(MD_NO_TBL_COPY_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_NO_TBL_COPY_ERR_EID, CFE_EVS_EventType_ERROR,
"Didn't update MD tbl #%d due to unexpected CFE_TBL_GetAddress return: 0x%08X",
TblIndex+1, (unsigned int)GetAddressResult);
}
@@ -474,15 +476,15 @@ int32 MD_InitTableServices( void )
MD_StartDwellStream ( (uint16) TblIndex);
}
- RecoveredValidTable=TRUE;
+ RecoveredValidTable=true;
TblRecos++;
- CFE_EVS_SendEvent(MD_RECOVERED_TBL_VALID_INF_EID, CFE_EVS_INFORMATION,
+ CFE_EVS_SendEvent(MD_RECOVERED_TBL_VALID_INF_EID, CFE_EVS_EventType_INFORMATION,
"Recovered Dwell Table #%d is valid and has been copied to the MD App",
TblIndex+1);
}
else
{
- CFE_EVS_SendEvent(MD_RECOVERED_TBL_NOT_VALID_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_RECOVERED_TBL_NOT_VALID_ERR_EID, CFE_EVS_EventType_ERROR,
"MD App will reinitialize Dwell Table #%d because recovered table is not valid",
TblIndex+1);
}
@@ -496,31 +498,31 @@ int32 MD_InitTableServices( void )
else if (Status == CFE_TBL_ERR_INVALID_SIZE)
{
- CFE_EVS_SendEvent (MD_DWELL_TBL_TOO_LARGE_CRIT_EID, CFE_EVS_CRITICAL,
- "Dwell Table(s) are too large to register: %d bytes, %d entries",
- MD_TBL_LOAD_LNGTH,
+ CFE_EVS_SendEvent (MD_DWELL_TBL_TOO_LARGE_CRIT_EID, CFE_EVS_EventType_CRITICAL,
+ "Dwell Table(s) are too large to register: %u bytes, %d entries",
+ (unsigned int)MD_TBL_LOAD_LNGTH,
MD_DWELL_TABLE_SIZE);
- TableInitValidFlag = FALSE;
+ TableInitValidFlag = false;
} /* end if */
else if (Status != CFE_SUCCESS)
{
- CFE_EVS_SendEvent (MD_TBL_REGISTER_CRIT_EID, CFE_EVS_CRITICAL,
- "CFE_TBL_Register error 0x%08X received for tbl#%d",
- (unsigned int)Status,TblIndex+1);
- TableInitValidFlag = FALSE;
+ CFE_EVS_SendEvent (MD_TBL_REGISTER_CRIT_EID, CFE_EVS_EventType_CRITICAL,
+ "CFE_TBL_Register error %d received for tbl#%d",
+ Status, TblIndex+1);
+ TableInitValidFlag = false;
} /* end if */
else
{
/* Table is registered and valid */
- TableInitValidFlag = TRUE;
+ TableInitValidFlag = true;
}
/*
** Load initial values if needed
*/
- if((RecoveredValidTable == FALSE) && (TableInitValidFlag == TRUE))
+ if((RecoveredValidTable == false) && (TableInitValidFlag == true))
{
Status = CFE_TBL_Load(MD_AppData.MD_TableHandle[TblIndex],
CFE_TBL_SRC_FILE, /* following ptr is memory ptr */
@@ -533,7 +535,7 @@ int32 MD_InitTableServices( void )
CFE_ES_WriteToSysLog
("MD_APP: Error 0x%08X received loading tbl#%d\n",
(unsigned int)Status,TblIndex+1);
- TableInitValidFlag = FALSE;
+ TableInitValidFlag = false;
}/* end if */
else
{
@@ -542,7 +544,7 @@ int32 MD_InitTableServices( void )
}
- if( TableInitValidFlag == TRUE)
+ if( TableInitValidFlag == true)
{
/* Update Dwell Table Control Info, including rate */
MD_UpdateDwellControlInfo(TblIndex);
@@ -551,12 +553,12 @@ int32 MD_InitTableServices( void )
} /* end for loop */
/* Output init and recovery event message */
- CFE_EVS_SendEvent(MD_TBL_INIT_INF_EID, CFE_EVS_INFORMATION,
+ CFE_EVS_SendEvent(MD_TBL_INIT_INF_EID, CFE_EVS_EventType_INFORMATION,
"Dwell Tables Recovered: %d, Dwell Tables Initialized: %d",
TblRecos, TblInits);
- if (TableInitValidFlag == TRUE)
+ if (TableInitValidFlag == true)
{
return CFE_SUCCESS;
}
@@ -574,7 +576,7 @@ int32 MD_ManageDwellTable (uint8 TblIndex)
{
int32 Status = CFE_SUCCESS;
int32 GetAddressResult = 0;
- boolean FinishedManaging = FALSE;
+ bool FinishedManaging = false;
MD_DwellTableLoad_t *MD_LoadTablePtr = 0;
while (!FinishedManaging)
@@ -592,7 +594,7 @@ int32 MD_ManageDwellTable (uint8 TblIndex)
{
/* If an error occurred during Validate, */
/* then do not perform any more managing */
- FinishedManaging = TRUE;
+ FinishedManaging = true;
}
}
else if (Status == CFE_TBL_INFO_UPDATE_PENDING)
@@ -616,9 +618,9 @@ int32 MD_ManageDwellTable (uint8 TblIndex)
}
else
{
- CFE_EVS_SendEvent(MD_NO_TBL_COPY_ERR_EID, CFE_EVS_ERROR,
-"Didn't update MD tbl #%d due to unexpected CFE_TBL_GetAddress return: 0x%08X",
- TblIndex+1, (unsigned int)GetAddressResult);
+ CFE_EVS_SendEvent(MD_NO_TBL_COPY_ERR_EID, CFE_EVS_EventType_ERROR,
+ "Didn't update MD tbl #%d due to unexpected CFE_TBL_GetAddress return: %d",
+ TblIndex+1, GetAddressResult);
}
/* Unlock Table */
@@ -627,19 +629,19 @@ int32 MD_ManageDwellTable (uint8 TblIndex)
/* After an Update, always assume we are done */
/* and return Update Status */
- FinishedManaging = TRUE;
+ FinishedManaging = true;
}
else if((Status & CFE_SEVERITY_BITMASK) == CFE_SEVERITY_ERROR)
{
- CFE_EVS_SendEvent(MD_TBL_STATUS_ERR_EID, CFE_EVS_ERROR,
- "Received unexpected error 0x%08X from CFE_TBL_GetStatus for tbl #%d",
- (unsigned int)Status, TblIndex+1);
- FinishedManaging = TRUE;
+ CFE_EVS_SendEvent(MD_TBL_STATUS_ERR_EID, CFE_EVS_EventType_ERROR,
+ "Received unexpected error %d from CFE_TBL_GetStatus for tbl #%d",
+ Status, TblIndex+1);
+ FinishedManaging = true;
}
else
{
- FinishedManaging = TRUE;
+ FinishedManaging = true;
}
}
@@ -669,7 +671,7 @@ void MD_ExecRequest(CFE_SB_MsgPtr_t MessagePtr )
/* If match wasn't found in command info structure, */
/* issue an error event, increment error counter, and return. */
- CFE_EVS_SendEvent (MD_CC_NOT_IN_TBL_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent (MD_CC_NOT_IN_TBL_ERR_EID, CFE_EVS_EventType_ERROR,
"Command Code %d not found in MD_CmdHandlerTbl structure",
CommandCode);
MD_AppData.ErrCounter++;
@@ -683,7 +685,7 @@ void MD_ExecRequest(CFE_SB_MsgPtr_t MessagePtr )
/* send error event, increment error count, and return. */
if (ActualLength != MD_CmdHandlerTbl[CmdIndx].ExpectedLength)
{
- CFE_EVS_SendEvent( MD_CMD_LEN_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent( MD_CMD_LEN_ERR_EID, CFE_EVS_EventType_ERROR,
"Cmd Msg with Bad length Rcvd: ID = 0x%04X, CC = %d, Exp Len = %d, Len = %d",
MessageID, CommandCode,
(int)MD_CmdHandlerTbl[CmdIndx].ExpectedLength, ActualLength);
@@ -698,7 +700,7 @@ void MD_ExecRequest(CFE_SB_MsgPtr_t MessagePtr )
{
case MD_NOOP_CC:
- CFE_EVS_SendEvent (MD_NOOP_INF_EID, CFE_EVS_INFORMATION,
+ CFE_EVS_SendEvent (MD_NOOP_INF_EID, CFE_EVS_EventType_INFORMATION,
"No-op command, Version %d.%d.%d.%d",
MD_MAJOR_VERSION,
MD_MINOR_VERSION,
@@ -710,7 +712,7 @@ void MD_ExecRequest(CFE_SB_MsgPtr_t MessagePtr )
case MD_RESET_CNTRS_CC:
- CFE_EVS_SendEvent (MD_RESET_CNTRS_DBG_EID, CFE_EVS_DEBUG,
+ CFE_EVS_SendEvent (MD_RESET_CNTRS_DBG_EID, CFE_EVS_EventType_DEBUG,
"Reset Counters Cmd Received");
MD_AppData.CmdCounter = 0;
MD_AppData.ErrCounter = 0;
@@ -739,7 +741,7 @@ void MD_ExecRequest(CFE_SB_MsgPtr_t MessagePtr )
default:
/* unknown function code specified - send error event message */
- CFE_EVS_SendEvent(MD_CC_NOT_IN_LOOP_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_CC_NOT_IN_LOOP_ERR_EID, CFE_EVS_EventType_ERROR,
"Command Code %d not found in command processing loop",
CommandCode);
MD_AppData.ErrCounter++;
@@ -755,7 +757,7 @@ void MD_ExecRequest(CFE_SB_MsgPtr_t MessagePtr )
/******************************************************************************/
void MD_HkStatus()
{
- uint8 TblIndex = 0;
+ uint8 TblIndex;
uint16 MemDwellEnableBits = 0;
MD_HkTlm_t *HkPktPtr = NULL;
MD_DwellPacketControl_t *ThisDwellTablePtr = NULL;
@@ -768,8 +770,6 @@ void MD_HkStatus()
HkPktPtr->ValidCmdCntr = MD_AppData.CmdCounter;
HkPktPtr->InvalidCmdCntr = MD_AppData.ErrCounter;
- MemDwellEnableBits = 0;
-
for (TblIndex=0; TblIndexTableMask))
{
/* At least one valid Table Id is in Mask */
- AnyTablesInMask=TRUE;
+ AnyTablesInMask=true;
}
}
@@ -102,7 +102,7 @@ void MD_ProcessStartCmd(CFE_SB_MsgPtr_t MessagePtr)
/* If table contains a rate of zero, report that no processing will occur */
if (MD_AppData.MD_DwellTables[ TableIndex ].Rate == 0)
{
- CFE_EVS_SendEvent(MD_ZERO_RATE_CMD_INF_EID, CFE_EVS_INFORMATION,
+ CFE_EVS_SendEvent(MD_ZERO_RATE_CMD_INF_EID, CFE_EVS_EventType_INFORMATION,
"Dwell Table %d is enabled with a delay of zero so no processing will occur", TableId);
}
}
@@ -112,7 +112,7 @@ void MD_ProcessStartCmd(CFE_SB_MsgPtr_t MessagePtr)
{
MD_AppData.CmdCounter++;
- CFE_EVS_SendEvent(MD_START_DWELL_INF_EID, CFE_EVS_INFORMATION,
+ CFE_EVS_SendEvent(MD_START_DWELL_INF_EID, CFE_EVS_EventType_INFORMATION,
"Start Dwell Table command processed successfully for table mask 0x%04X",
Start->TableMask);
@@ -121,7 +121,7 @@ void MD_ProcessStartCmd(CFE_SB_MsgPtr_t MessagePtr)
{
MD_AppData.ErrCounter++;
- CFE_EVS_SendEvent(MD_START_DWELL_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_START_DWELL_ERR_EID, CFE_EVS_EventType_ERROR,
"Start Dwell Table for mask 0x%04X failed for %d of %d tables",
Start->TableMask, ErrorCount, NumTblInMask);
}
@@ -129,7 +129,7 @@ void MD_ProcessStartCmd(CFE_SB_MsgPtr_t MessagePtr)
else /* No valid table id's specified in mask */
{
MD_AppData.ErrCounter++;
- CFE_EVS_SendEvent(MD_EMPTY_TBLMASK_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_EMPTY_TBLMASK_ERR_EID, CFE_EVS_EventType_ERROR,
"%s command rejected because no tables were specified in table mask (0x%04X)",
"Start Dwell", Start->TableMask );
}
@@ -147,7 +147,7 @@ void MD_ProcessStopCmd(CFE_SB_MsgPtr_t MessagePtr)
MD_CmdStartStop_t *Stop = NULL;
uint16 TableId = 0;
uint16 TableIndex = 0;
- boolean AnyTablesInMask = FALSE;
+ bool AnyTablesInMask = false;
/*
** Cast message to StartStop Command.
@@ -165,7 +165,7 @@ void MD_ProcessStopCmd(CFE_SB_MsgPtr_t MessagePtr)
MD_AppData.MD_DwellTables[ TableIndex ].CurrentEntry = 0;
MD_AppData.MD_DwellTables[ TableIndex ].PktOffset = 0;
- AnyTablesInMask=TRUE;
+ AnyTablesInMask=true;
/* Change value in Table Services managed buffer */
Status = MD_UpdateTableEnabledField (TableIndex, MD_DWELL_STREAM_DISABLED);
@@ -180,7 +180,7 @@ void MD_ProcessStopCmd(CFE_SB_MsgPtr_t MessagePtr)
{
if(ErrorCount == 0)
{
- CFE_EVS_SendEvent(MD_STOP_DWELL_INF_EID, CFE_EVS_INFORMATION,
+ CFE_EVS_SendEvent(MD_STOP_DWELL_INF_EID, CFE_EVS_EventType_INFORMATION,
"Stop Dwell Table command processed successfully for table mask 0x%04X",
Stop->TableMask );
@@ -190,14 +190,14 @@ void MD_ProcessStopCmd(CFE_SB_MsgPtr_t MessagePtr)
{
MD_AppData.ErrCounter++;
- CFE_EVS_SendEvent(MD_STOP_DWELL_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_STOP_DWELL_ERR_EID, CFE_EVS_EventType_ERROR,
"Stop Dwell Table for mask 0x%04X failed for %d of %d tables",
Stop->TableMask, ErrorCount, NumTblInMask);
}
}
else
{
- CFE_EVS_SendEvent(MD_EMPTY_TBLMASK_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_EMPTY_TBLMASK_ERR_EID, CFE_EVS_EventType_ERROR,
"%s command rejected because no tables were specified in table mask (0x%04X)",
"Stop Dwell", Stop->TableMask );
MD_AppData.ErrCounter++;
@@ -212,7 +212,7 @@ void MD_ProcessJamCmd(CFE_SB_MsgPtr_t MessagePtr)
/* Local variables */
int32 Status = CFE_SUCCESS;
MD_CmdJam_t *Jam = 0;
- boolean AllInputsValid = TRUE;
+ bool AllInputsValid = true;
cpuaddr ResolvedAddr = 0;
MD_DwellControlEntry_t *DwellEntryPtr = 0; /* points to local task data */
uint16 EntryIndex = 0;
@@ -233,24 +233,24 @@ void MD_ProcessJamCmd(CFE_SB_MsgPtr_t MessagePtr)
*/
if ( !MD_ValidTableId ( Jam->TableId) )
{
- CFE_EVS_SendEvent(MD_INVALID_JAM_TABLE_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_INVALID_JAM_TABLE_ERR_EID, CFE_EVS_EventType_ERROR,
"Jam Cmd rejected due to invalid Tbl Id arg = %d (Expect 1.. %d)",
Jam->TableId, MD_NUM_DWELL_TABLES);
- AllInputsValid = FALSE;
+ AllInputsValid = false;
}
else if (!MD_ValidEntryId ( Jam->EntryId))
{
- CFE_EVS_SendEvent(MD_INVALID_ENTRY_ARG_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_INVALID_ENTRY_ARG_ERR_EID, CFE_EVS_EventType_ERROR,
"Jam Cmd rejected due to invalid Entry Id arg = %d (Expect 1.. %d)",
Jam->EntryId, MD_DWELL_TABLE_SIZE);
- AllInputsValid = FALSE;
+ AllInputsValid = false;
}
else
{
- AllInputsValid = TRUE;
+ AllInputsValid = true;
}
@@ -258,7 +258,7 @@ void MD_ProcessJamCmd(CFE_SB_MsgPtr_t MessagePtr)
/*
** If all inputs checked so far are valid, continue.
*/
- if (AllInputsValid == TRUE)
+ if (AllInputsValid == true)
{
TableIndex = Jam->TableId-1;
EntryIndex = Jam->EntryId-1;
@@ -283,17 +283,17 @@ void MD_ProcessJamCmd(CFE_SB_MsgPtr_t MessagePtr)
/* Issue event */
if(Status == CFE_SUCCESS)
{
- CFE_EVS_SendEvent(MD_JAM_NULL_DWELL_INF_EID, CFE_EVS_INFORMATION,
+ CFE_EVS_SendEvent(MD_JAM_NULL_DWELL_INF_EID, CFE_EVS_EventType_INFORMATION,
"Successful Jam of a Null Dwell Entry to Dwell Tbl#%d Entry #%d",
Jam->TableId, Jam->EntryId );
}
else
{
- CFE_EVS_SendEvent(MD_JAM_NULL_DWELL_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_JAM_NULL_DWELL_ERR_EID, CFE_EVS_EventType_ERROR,
"Failed Jam of a Null Dwell Entry to Dwell Tbl#%d Entry #%d",
Jam->TableId, Jam->EntryId );
- AllInputsValid = FALSE;
+ AllInputsValid = false;
}
}
else
@@ -306,65 +306,65 @@ void MD_ProcessJamCmd(CFE_SB_MsgPtr_t MessagePtr)
*/
/* Resolve and Validate Dwell Address */
- if (CFS_ResolveSymAddr(&Jam->DwellAddress,&ResolvedAddr) == FALSE)
+ if (CFS_ResolveSymAddr(&Jam->DwellAddress,&ResolvedAddr) == false)
{
/* If DwellAddress argument couldn't be resolved, issue error event */
CFE_EVS_SendEvent(MD_CANT_RESOLVE_JAM_ADDR_ERR_EID,
- CFE_EVS_ERROR,
+ CFE_EVS_EventType_ERROR,
"Jam Cmd rejected because symbolic address '%s' couldn't be resolved",
Jam->DwellAddress.SymName);
- AllInputsValid = FALSE;
+ AllInputsValid = false;
}
else if (!MD_ValidFieldLength(Jam->FieldLength))
{
- CFE_EVS_SendEvent(MD_INVALID_LEN_ARG_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_INVALID_LEN_ARG_ERR_EID, CFE_EVS_EventType_ERROR,
"Jam Cmd rejected due to invalid Field Length arg = %d (Expect 0,1,2,or 4)",
Jam->FieldLength);
- AllInputsValid = FALSE;
+ AllInputsValid = false;
}
else if (!MD_ValidAddrRange(ResolvedAddr, Jam->FieldLength))
{
/* Issue event message that ResolvedAddr is invalid */
- CFE_EVS_SendEvent(MD_INVALID_JAM_ADDR_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_INVALID_JAM_ADDR_ERR_EID, CFE_EVS_EventType_ERROR,
"Jam Cmd rejected because address 0x%08X is not in a valid range",
(unsigned int)ResolvedAddr);
- AllInputsValid = FALSE;
+ AllInputsValid = false;
}
#if MD_ENFORCE_DWORD_ALIGN == 0
else if ((Jam->FieldLength == 4) &&
- CFS_Verify16Aligned(ResolvedAddr, (uint32)Jam->FieldLength) != TRUE)
+ CFS_Verify16Aligned(ResolvedAddr, (uint32)Jam->FieldLength) != true)
{
- CFE_EVS_SendEvent(MD_JAM_ADDR_NOT_16BIT_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_JAM_ADDR_NOT_16BIT_ERR_EID, CFE_EVS_EventType_ERROR,
"Jam Cmd rejected because address 0x%08X is not 16-bit aligned",
ResolvedAddr);
- AllInputsValid = FALSE;
+ AllInputsValid = false;
}
#else
else if ((Jam->FieldLength == 4) &&
- CFS_Verify32Aligned(ResolvedAddr, (uint32)Jam->FieldLength) != TRUE)
+ CFS_Verify32Aligned(ResolvedAddr, (uint32)Jam->FieldLength) != true)
{
- CFE_EVS_SendEvent(MD_JAM_ADDR_NOT_32BIT_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_JAM_ADDR_NOT_32BIT_ERR_EID, CFE_EVS_EventType_ERROR,
"Jam Cmd rejected because address 0x%08X is not 32-bit aligned",
(unsigned int)ResolvedAddr);
- AllInputsValid = FALSE;
+ AllInputsValid = false;
}
#endif
- else if ((Jam->FieldLength == 2) && CFS_Verify16Aligned(ResolvedAddr, (uint32)Jam->FieldLength) != TRUE)
+ else if ((Jam->FieldLength == 2) && CFS_Verify16Aligned(ResolvedAddr, (uint32)Jam->FieldLength) != true)
{
- CFE_EVS_SendEvent(MD_JAM_ADDR_NOT_16BIT_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_JAM_ADDR_NOT_16BIT_ERR_EID, CFE_EVS_EventType_ERROR,
"Jam Cmd rejected because address 0x%08X is not 16-bit aligned",
(unsigned int)ResolvedAddr);
- AllInputsValid = FALSE;
+ AllInputsValid = false;
}
else
{
/* All inputs are valid */
- AllInputsValid = TRUE;
+ AllInputsValid = true;
}
- if (AllInputsValid == TRUE)
+ if (AllInputsValid == true)
/*
** Perform Jam Operation : Copy Resolved DwellAddress, Length, and Delay to
** local control structure.
@@ -390,17 +390,17 @@ void MD_ProcessJamCmd(CFE_SB_MsgPtr_t MessagePtr)
/* Issue event */
if(Status == CFE_SUCCESS)
{
- CFE_EVS_SendEvent(MD_JAM_DWELL_INF_EID, CFE_EVS_INFORMATION,
+ CFE_EVS_SendEvent(MD_JAM_DWELL_INF_EID, CFE_EVS_EventType_INFORMATION,
"Successful Jam to Dwell Tbl#%d Entry #%d",
Jam->TableId, Jam->EntryId );
}
else
{
- CFE_EVS_SendEvent(MD_JAM_DWELL_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_JAM_DWELL_ERR_EID, CFE_EVS_EventType_ERROR,
"Failed Jam to Dwell Tbl#%d Entry #%d",
Jam->TableId, Jam->EntryId );
- AllInputsValid = FALSE;
+ AllInputsValid = false;
}
}
@@ -411,7 +411,7 @@ void MD_ProcessJamCmd(CFE_SB_MsgPtr_t MessagePtr)
/*
** Handle bookkeeping.
*/
- if (AllInputsValid == TRUE)
+ if (AllInputsValid == true)
{
MD_AppData.CmdCounter++;
@@ -422,7 +422,7 @@ void MD_ProcessJamCmd(CFE_SB_MsgPtr_t MessagePtr)
if ((MD_AppData.MD_DwellTables[ TableIndex ].Rate == 0) &&
(MD_AppData.MD_DwellTables[ TableIndex ].Enabled == MD_DWELL_STREAM_ENABLED))
{
- CFE_EVS_SendEvent(MD_ZERO_RATE_CMD_INF_EID, CFE_EVS_INFORMATION,
+ CFE_EVS_SendEvent(MD_ZERO_RATE_CMD_INF_EID, CFE_EVS_EventType_INFORMATION,
"Dwell Table %d is enabled with a delay of zero so no processing will occur", Jam->TableId);
}
}
@@ -445,7 +445,7 @@ void MD_ProcessSignatureCmd(CFE_SB_MsgPtr_t MessagePtr)
int32 Status = CFE_SUCCESS;
MD_CmdSetSignature_t *SignatureCmd = NULL;
uint16 TblId = 0;
- uint16 StringLength = 0;
+ uint16 StringLength;
/*
@@ -466,7 +466,7 @@ void MD_ProcessSignatureCmd(CFE_SB_MsgPtr_t MessagePtr)
if (StringLength >= MD_SIGNATURE_FIELD_LENGTH)
{
- CFE_EVS_SendEvent(MD_INVALID_SIGNATURE_LENGTH_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_INVALID_SIGNATURE_LENGTH_ERR_EID, CFE_EVS_EventType_ERROR,
"Set Signature cmd rejected due to invalid Signature length");
MD_AppData.ErrCounter++;
@@ -477,7 +477,7 @@ void MD_ProcessSignatureCmd(CFE_SB_MsgPtr_t MessagePtr)
*/
else if ( !MD_ValidTableId ( TblId) )
{
- CFE_EVS_SendEvent(MD_INVALID_SIGNATURE_TABLE_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_INVALID_SIGNATURE_TABLE_ERR_EID, CFE_EVS_EventType_ERROR,
"Set Signature cmd rejected due to invalid Tbl Id arg = %d (Expect 1.. %d)",
TblId, MD_NUM_DWELL_TABLES);
@@ -499,7 +499,7 @@ void MD_ProcessSignatureCmd(CFE_SB_MsgPtr_t MessagePtr)
Status = MD_UpdateTableSignature(TblId-1,SignatureCmd->Signature);
if(Status == CFE_SUCCESS)
{
- CFE_EVS_SendEvent(MD_SET_SIGNATURE_INF_EID, CFE_EVS_INFORMATION,
+ CFE_EVS_SendEvent(MD_SET_SIGNATURE_INF_EID, CFE_EVS_EventType_INFORMATION,
"Successfully set signature for Dwell Tbl#%d to '%s'",
TblId, SignatureCmd->Signature );
@@ -507,7 +507,7 @@ void MD_ProcessSignatureCmd(CFE_SB_MsgPtr_t MessagePtr)
}
else
{
- CFE_EVS_SendEvent(MD_SET_SIGNATURE_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_SET_SIGNATURE_ERR_EID, CFE_EVS_EventType_ERROR,
"Failed to set signature for Dwell Tbl#%d. Update returned 0x%08X",
TblId, Status);
diff --git a/fsw/src/md_cmds.h b/fsw/src/md_cmds.h
index 248e906..6590e87 100644
--- a/fsw/src/md_cmds.h
+++ b/fsw/src/md_cmds.h
@@ -2,7 +2,7 @@
** File: md_cmds.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/src/md_dwell_pkt.c b/fsw/src/md_dwell_pkt.c
index b9f2fbb..93bbc3b 100644
--- a/fsw/src/md_dwell_pkt.c
+++ b/fsw/src/md_dwell_pkt.c
@@ -2,7 +2,7 @@
** File: md_dwell_pkt.c
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
@@ -42,7 +42,7 @@ extern MD_AppData_t MD_AppData;
void MD_DwellLoop( void )
{
int32 Result = 0;
- uint16 TblIndex = 0;
+ uint16 TblIndex;
uint16 EntryIndex = 0;
uint16 NumDwellAddresses = 0;
MD_DwellPacketControl_t *TblPtr = NULL;
@@ -95,7 +95,7 @@ void MD_DwellLoop( void )
if (Result == -1 )
{
/* Send error event message */
- CFE_EVS_SendEvent(MD_DWELL_LOOP_GET_DWELL_DATA_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_DWELL_LOOP_GET_DWELL_DATA_ERR_EID, CFE_EVS_EventType_ERROR,
"Dwell Table failed to read entry %d in table %d ", EntryIndex, TblIndex);
/* Don't exit here yet, still need to increment counters or send the packet */
}
@@ -169,34 +169,31 @@ int32 MD_GetDwellData( uint16 TblIndex, uint16 EntryIndex )
/* fetch data pointed to by this address */
DwellAddress = TblPtr->Entry[EntryIndex].ResolvedAddress;
- if (NumBytes == 1)
+ switch(NumBytes)
{
- if (CFE_PSP_MemRead8( DwellAddress, (uint8 *) &MemReadVal ) != CFE_SUCCESS)
- {
- Status = -1;
- }
- }
-
- else if (NumBytes == 2)
- {
- if (CFE_PSP_MemRead16( DwellAddress, (uint16 *) &MemReadVal ) != CFE_SUCCESS)
- {
- Status = -1;
- }
- }
-
- else if (NumBytes == 4)
- {
- if (CFE_PSP_MemRead32( DwellAddress, &MemReadVal ) != CFE_SUCCESS)
- {
- Status = -1;
- }
- }
-
- else /* Invalid dwell length */
- /* Shouldn't ever get here unless length value was corrupted. */
- {
- Status = -1;
+ case 1:
+ if (CFE_PSP_MemRead8( DwellAddress, (uint8 *) &MemReadVal ) != CFE_SUCCESS)
+ {
+ Status = -1;
+ }
+ break;
+ case 2:
+ if (CFE_PSP_MemRead16( DwellAddress, (uint16 *) &MemReadVal ) != CFE_SUCCESS)
+ {
+ Status = -1;
+ }
+ break;
+ case 4:
+ if (CFE_PSP_MemRead32( DwellAddress, &MemReadVal ) != CFE_SUCCESS)
+ {
+ Status = -1;
+ }
+ break;
+ default:
+ /* Invalid dwell length */
+ /* Shouldn't ever get here unless length value was corrupted. */
+ Status = -1;
+ break;
}
@@ -205,9 +202,9 @@ int32 MD_GetDwellData( uint16 TblIndex, uint16 EntryIndex )
/* didn't read. */
if (Status == CFE_SUCCESS)
{
- CFE_PSP_MemCpy( (void*) &MD_AppData.MD_DwellPkt[TblIndex].Data[TblPtr->PktOffset],
- (void*) &MemReadVal,
- NumBytes);
+ CFE_PSP_MemCpy( (void*) &MD_AppData.MD_DwellPkt[TblIndex].Data[TblPtr->PktOffset],
+ (void*) &MemReadVal,
+ NumBytes);
}
/* Update write location in dwell packet */
@@ -248,13 +245,13 @@ void MD_SendDwellPkt( uint16 TableIndex )
DwellPktSize = MD_DWELL_PKT_LNGTH - MD_DWELL_TABLE_SIZE * 4 + TblPtr->DataSize;
- CFE_SB_SetTotalMsgLength((CFE_SB_Msg_t *)PktPtr, DwellPktSize);
+ CFE_SB_SetTotalMsgLength((CFE_SB_MsgPtr_t)PktPtr, DwellPktSize);
/*
- ** Send housekeeping telemetry packet.
+ ** Send dwell telemetry packet.
*/
- CFE_SB_TimeStampMsg((CFE_SB_Msg_t *) PktPtr);
- CFE_SB_SendMsg((CFE_SB_Msg_t *) PktPtr);
+ CFE_SB_TimeStampMsg((CFE_SB_MsgPtr_t)PktPtr);
+ CFE_SB_SendMsg((CFE_SB_MsgPtr_t)PktPtr);
} /* End of MD_SendDwellPkt */
diff --git a/fsw/src/md_dwell_pkt.h b/fsw/src/md_dwell_pkt.h
index 4d04b64..8c18232 100644
--- a/fsw/src/md_dwell_pkt.h
+++ b/fsw/src/md_dwell_pkt.h
@@ -2,7 +2,7 @@
** File: md_dwell_pkt.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/src/md_dwell_tbl.c b/fsw/src/md_dwell_tbl.c
index 03a43be..fa53ca9 100644
--- a/fsw/src/md_dwell_tbl.c
+++ b/fsw/src/md_dwell_tbl.c
@@ -2,7 +2,7 @@
** File: md_dwell_tbl.c
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
@@ -54,7 +54,7 @@ int32 MD_TableValidationFunc (void *TblPtr)
{
Status = MD_INVALID_ADDR_ERROR;
- CFE_EVS_SendEvent(MD_TBL_VAL_NULL_PTR_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_TBL_VAL_NULL_PTR_ERR_EID, CFE_EVS_EventType_ERROR,
"Dwell Table rejected because of null table pointer");
return Status;
@@ -80,7 +80,7 @@ int32 MD_TableValidationFunc (void *TblPtr)
if ((LocalTblPtr->Enabled != MD_DWELL_STREAM_DISABLED) &&
(LocalTblPtr->Enabled != MD_DWELL_STREAM_ENABLED))
{
- CFE_EVS_SendEvent(MD_TBL_ENA_FLAG_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_TBL_ENA_FLAG_EID, CFE_EVS_EventType_ERROR,
"Dwell Table rejected because value of enable flag (%d) is invalid",
(int)LocalTblPtr->Enabled);
Status = MD_TBL_ENA_FLAG_ERROR;
@@ -90,7 +90,7 @@ int32 MD_TableValidationFunc (void *TblPtr)
else if(StringLength >= MD_SIGNATURE_FIELD_LENGTH)
{
- CFE_EVS_SendEvent(MD_TBL_SIG_LEN_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_TBL_SIG_LEN_ERR_EID, CFE_EVS_EventType_ERROR,
"Dwell Table rejected because Signature length was invalid");
Status = MD_SIG_LEN_TBL_ERROR;
@@ -111,13 +111,13 @@ int32 MD_TableValidationFunc (void *TblPtr)
/* Allow ground to uplink a table with 0 delay, but if the table is enabled, report that the table will not be processed */
if ((LocalTblPtr->Enabled == MD_DWELL_STREAM_ENABLED) && (Rate == 0))
{
- CFE_EVS_SendEvent(MD_ZERO_RATE_TBL_INF_EID, CFE_EVS_INFORMATION,
+ CFE_EVS_SendEvent(MD_ZERO_RATE_TBL_INF_EID, CFE_EVS_EventType_INFORMATION,
"Dwell Table is enabled but no processing will occur for table being loaded (rate is zero)");
}
}
else if (Status == MD_RESOLVE_ERROR)
{
- CFE_EVS_SendEvent(MD_RESOLVE_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_RESOLVE_ERR_EID, CFE_EVS_EventType_ERROR,
"Dwell Table rejected because address (sym='%s'/offset=0x%08X) in entry #%d couldn't be resolved",
LocalTblPtr->Entry[TblErrorEntryIndex].DwellAddress.SymName,
(unsigned int)LocalTblPtr->Entry[TblErrorEntryIndex].DwellAddress.Offset,
@@ -125,7 +125,7 @@ int32 MD_TableValidationFunc (void *TblPtr)
}
else if (Status == MD_INVALID_ADDR_ERROR)
{
- CFE_EVS_SendEvent(MD_RANGE_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_RANGE_ERR_EID, CFE_EVS_EventType_ERROR,
"Dwell Table rejected because address (sym='%s'/offset=0x%08X) in entry #%d was out of range",
LocalTblPtr->Entry[TblErrorEntryIndex].DwellAddress.SymName,
(unsigned int)LocalTblPtr->Entry[TblErrorEntryIndex].DwellAddress.Offset,
@@ -134,14 +134,14 @@ int32 MD_TableValidationFunc (void *TblPtr)
}
else if (Status == MD_INVALID_LEN_ERROR)
{
- CFE_EVS_SendEvent(MD_TBL_HAS_LEN_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_TBL_HAS_LEN_ERR_EID, CFE_EVS_EventType_ERROR,
"Dwell Table rejected because length (%d) in entry #%d was invalid",
LocalTblPtr->Entry[TblErrorEntryIndex].Length,
TblErrorEntryIndex + 1);
}
else if(Status == MD_NOT_ALIGNED_ERROR)
{
- CFE_EVS_SendEvent(MD_TBL_ALIGN_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_TBL_ALIGN_ERR_EID, CFE_EVS_EventType_ERROR,
"Dwell Table rejected because address (sym='%s'/offset=0x%08X) in entry #%d not properly aligned for %d-byte dwell",
LocalTblPtr->Entry[TblErrorEntryIndex].DwellAddress.SymName,
(unsigned int)LocalTblPtr->Entry[TblErrorEntryIndex].DwellAddress.Offset,
@@ -170,7 +170,7 @@ int32 MD_ReadDwellTable(MD_DwellTableLoad_t *TblPtr,
{
/* parameters cannot be NULL - checked by calling function */
- uint16 EntryId = 0;
+ uint16 EntryId;
*ActiveAddrCountPtr = 0;
*SizePtr = 0;
*RatePtr = 0;
@@ -193,13 +193,13 @@ int32 MD_ReadDwellTable(MD_DwellTableLoad_t *TblPtr,
int32 MD_CheckTableEntries(MD_DwellTableLoad_t *TblPtr,
uint16 *ErrorEntryArg)
{
- int32 Status = CFE_SUCCESS;
- uint16 EntryIndex = 0;
- int32 FirstBadIndex = -1;
+ int32 Status = CFE_SUCCESS;
+ uint16 EntryIndex;
+ int32 FirstBadIndex = -1;
- int32 GoodCount = 0;
- int32 BadCount = 0;
- int32 UnusedCount = 0;
+ int32 GoodCount = 0;
+ int32 BadCount = 0;
+ int32 UnusedCount = 0;
*ErrorEntryArg = 0;
@@ -248,7 +248,7 @@ int32 MD_CheckTableEntries(MD_DwellTableLoad_t *TblPtr,
/*
** Generate informational event with error totals
*/
- CFE_EVS_SendEvent(MD_DWELL_TBL_INF_EID, CFE_EVS_INFORMATION,
+ CFE_EVS_SendEvent(MD_DWELL_TBL_INF_EID, CFE_EVS_EventType_INFORMATION,
"MD Dwell Tbl verify results: good = %d, bad = %d, unused = %d",
(int)GoodCount, (int)BadCount, (int)UnusedCount);
return Status;
@@ -258,7 +258,7 @@ int32 MD_CheckTableEntries(MD_DwellTableLoad_t *TblPtr,
/******************************************************************************/
int32 MD_ValidTableEntry (MD_TableLoadEntry_t *TblEntryPtr)
{
- int32 Status = CFE_SUCCESS;
+ int32 Status = MD_ERROR;
uint16 DwellLength = 0;
cpuaddr ResolvedAddr = 0;
@@ -271,34 +271,34 @@ int32 MD_ValidTableEntry (MD_TableLoadEntry_t *TblEntryPtr)
else
{
if (CFS_ResolveSymAddr(&TblEntryPtr->DwellAddress,
- &ResolvedAddr) != TRUE)
+ &ResolvedAddr) != true)
{ /* Symbol was non-null AND was not in Symbol Table */
Status = MD_RESOLVE_ERROR;
} /* end CFS_ResolveSymAddr */
- else if (MD_ValidAddrRange( ResolvedAddr, (uint32)DwellLength) != TRUE)
+ else if (MD_ValidAddrRange( ResolvedAddr, (uint32)DwellLength) != true)
{ /* Address is in invalid range */
Status = MD_INVALID_ADDR_ERROR;
}
- else if (MD_ValidFieldLength(DwellLength) != TRUE)
+ else if (MD_ValidFieldLength(DwellLength) != true)
{
Status = MD_INVALID_LEN_ERROR;
}
#if MD_ENFORCE_DWORD_ALIGN == 0
else if ((DwellLength == 4)
- && CFS_Verify16Aligned(ResolvedAddr, (uint32)DwellLength) != TRUE)
+ && CFS_Verify16Aligned(ResolvedAddr, (uint32)DwellLength) != true)
{
Status = MD_NOT_ALIGNED_ERROR;
}
#else
else if ((DwellLength == 4)
- && CFS_Verify32Aligned(ResolvedAddr, (uint32)DwellLength) != TRUE)
+ && CFS_Verify32Aligned(ResolvedAddr, (uint32)DwellLength) != true)
{
Status = MD_NOT_ALIGNED_ERROR;
}
#endif
else if ((DwellLength == 2)
- && CFS_Verify16Aligned(ResolvedAddr, (uint32)DwellLength) != TRUE)
+ && CFS_Verify16Aligned(ResolvedAddr, (uint32)DwellLength) != true)
{
Status = MD_NOT_ALIGNED_ERROR;
}
@@ -316,7 +316,7 @@ int32 MD_ValidTableEntry (MD_TableLoadEntry_t *TblEntryPtr)
/******************************************************************************/
void MD_CopyUpdatedTbl(MD_DwellTableLoad_t *MD_LoadTablePtr, uint8 TblIndex)
{
- uint8 EntryIndex = 0;
+ uint8 EntryIndex;
cpuaddr ResolvedAddr = 0;
MD_TableLoadEntry_t *ThisLoadEntry = NULL;
MD_DwellPacketControl_t *LocalControlStruct = NULL;
@@ -380,7 +380,7 @@ int32 MD_UpdateTableEnabledField (uint16 TableIndex, uint16 FieldValue)
if((GetAddressResult != CFE_SUCCESS) &&
(GetAddressResult != CFE_TBL_INFO_UPDATED))
{
- CFE_EVS_SendEvent(MD_UPDATE_TBL_EN_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_UPDATE_TBL_EN_ERR_EID, CFE_EVS_EventType_ERROR,
"MD_UpdateTableEnabledField, TableIndex %d: CFE_TBL_GetAddress Returned 0x%08x",
TableIndex, GetAddressResult);
Status = GetAddressResult;
@@ -419,7 +419,7 @@ int32 MD_UpdateTableDwellEntry (uint16 TableIndex,
if((GetAddressResult != CFE_SUCCESS) &&
(GetAddressResult != CFE_TBL_INFO_UPDATED))
{
- CFE_EVS_SendEvent(MD_UPDATE_TBL_DWELL_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_UPDATE_TBL_DWELL_ERR_EID, CFE_EVS_EventType_ERROR,
"MD_UpdateTableDwellEntry, TableIndex %d: CFE_TBL_GetAddress Returned 0x%08x",
TableIndex, GetAddressResult);
Status = GetAddressResult;
@@ -471,7 +471,7 @@ int32 MD_UpdateTableSignature (uint16 TableIndex,
if((GetAddressResult != CFE_SUCCESS) &&
(GetAddressResult != CFE_TBL_INFO_UPDATED))
{
- CFE_EVS_SendEvent(MD_UPDATE_TBL_SIG_ERR_EID, CFE_EVS_ERROR,
+ CFE_EVS_SendEvent(MD_UPDATE_TBL_SIG_ERR_EID, CFE_EVS_EventType_ERROR,
"MD_UpdateTableSignature, TableIndex %d: CFE_TBL_GetAddress Returned 0x%08x",
TableIndex, GetAddressResult);
Status = GetAddressResult;
diff --git a/fsw/src/md_dwell_tbl.h b/fsw/src/md_dwell_tbl.h
index a010d97..0028278 100644
--- a/fsw/src/md_dwell_tbl.h
+++ b/fsw/src/md_dwell_tbl.h
@@ -2,7 +2,7 @@
** File: md_dwell_tbl.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/src/md_events.h b/fsw/src/md_events.h
index a0cc87f..d28eec2 100644
--- a/fsw/src/md_events.h
+++ b/fsw/src/md_events.h
@@ -2,7 +2,7 @@
** File: md_events.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
@@ -764,6 +764,61 @@
*/
#define MD_DWELL_LOOP_GET_DWELL_DATA_ERR_EID 70
+
+/** \brief 'Failed to create pipe. RC = %d'
+** \event 'Failed to create pipe. RC = %d'
+**
+** \par Type: ERROR
+**
+** \par Cause:
+**
+** This event message is issued when MD cannot create the software bus pipe.
+** The RC field is the return code from #CFE_SB_CreatePipe.
+*/
+#define MD_CREATE_PIPE_ERR_EID 71
+
+
+/** \brief 'Failed to subscribe to HK requests. RC = %d'
+** \event 'Failed to subscribe to HK requests. RC = %d'
+**
+** \par Type: ERROR
+**
+** \par Cause:
+**
+** This event message is issued when MD cannot subscribe to housekeeping
+** requests.
+** The RC field is the return code from #CFE_SB_Subscribe
+*/
+#define MD_SUB_HK_ERR_EID 72
+
+
+/** \brief 'Failed to subscribe to commands. RC = %d'
+** \event 'Failed to subscribe to commands. RC = %d'
+**
+** \par Type: ERROR
+**
+** \par Cause:
+**
+** This event message is issued when MD cannot subscribe to commands.
+** The RC field is the return code from #CFE_SB_Subscribe
+*/
+#define MD_SUB_CMD_ERR_EID 73
+
+
+/** \brief 'Failed to subscribe to wakeup messages. RC = %d'
+** \event 'Failed to subscribe to wakeup messages. RC = %d'
+**
+** \par Type: ERROR
+**
+** \par Cause:
+**
+** This event message is issued when MD cannot subscribe to wakeup
+** messages.
+** The RC field is the return code from #CFE_SB_Subscribe
+*/
+#define MD_SUB_WAKEUP_ERR_EID 74
+
+
#endif
/************************/
/* End of File Comment */
diff --git a/fsw/src/md_msg.h b/fsw/src/md_msg.h
index e4a2051..e4387d8 100644
--- a/fsw/src/md_msg.h
+++ b/fsw/src/md_msg.h
@@ -2,7 +2,7 @@
** File: md_msg.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
@@ -62,7 +62,7 @@
*/
typedef struct
{
- uint8 CmdHeader[CFE_SB_CMD_HDR_SIZE]; /**< \brief cFE Software Bus Command Message Header */
+ CFE_SB_CmdHdr_t CmdHeader; /**< \brief cFE Software Bus Command Message Header */
} MD_NoArgsCmd_t;
@@ -74,9 +74,10 @@ typedef struct
**/
typedef struct
{
- uint8 Header[CFE_SB_CMD_HDR_SIZE]; /**< \brief cFE Software Bus Command Message Header */
- uint16 TableMask; /**< \brief 0x0001=TBL1 bit,
+ CFE_SB_CmdHdr_t Header; /**< \brief cFE Software Bus Command Message Header */
+ uint16 TableMask; /**< \brief 0x0001=TBL1 bit,
0x0002=TBL2 bit,0x0004=TBL3 bit,0x0008=TBL4 enable bit, etc. */
+ uint16 Padding; /**< \brief structure padding */
} MD_CmdStartStop_t;
@@ -89,7 +90,8 @@ typedef struct
**/
typedef struct /* for MD_JAM_DWELL */
{
- uint8 Header[CFE_SB_CMD_HDR_SIZE]; /**< \brief cFE Software Bus Command Message Header */
+ CFE_SB_CmdHdr_t Header; /**< \brief cFE Software Bus Command Message Header */
+
uint16 TableId; /**< \brief Table Id: 1..#MD_NUM_DWELL_TABLES */
uint16 EntryId; /**< \brief Address index: 1..#MD_DWELL_TABLE_SIZE */
uint16 FieldLength; /**< \brief Length of Dwell Field : 0, 1, 2, or 4 */
@@ -106,8 +108,8 @@ typedef struct /* for MD_JAM_DWELL */
**/
typedef struct
{
- uint8 Header[CFE_SB_CMD_HDR_SIZE];
- /**< \brief cFE Software Bus Command Message Header */
+ CFE_SB_CmdHdr_t Header; /**< \brief cFE Software Bus Command Message Header */
+
uint16 TableId; /**< \brief Table Id: 1..MD_NUM_DWELL_TABLES */
uint16 Padding; /**< \brief Padding */
char Signature[MD_SIGNATURE_FIELD_LENGTH];
@@ -125,18 +127,20 @@ typedef struct
typedef struct
{
- uint8 TlmHeader[CFE_SB_TLM_HDR_SIZE]; /**< \brief cFE SB Tlm Msg Hdr */
+ CFE_SB_TlmHdr_t TlmHeader; /**< \brief cFE SB Tlm Msg Hdr */
+
/*
** Task command interface counters...
*/
- uint8 InvalidCmdCntr; /**< \mdtlmmnemonic \MD_CMDEC
- \brief Count of invalid commands received */
- uint8 ValidCmdCntr; /**< \mdtlmmnemonic \MD_CMDPC
- \brief Count of valid commands received */
- uint16 DwellEnabledMask; /**< \mdtlmmnemonic \MD_ENABLEMASK
- \brief Each bit in bit mask enables a table
- 0x0001=TBL1 enable bit,0x0002=TBL2 enable bit,
- 0x0004=TBL3 enable bit,0x0008=TBL4 enable bit, etc. */
+ uint8 InvalidCmdCntr; /**< \mdtlmmnemonic \MD_CMDEC
+ \brief Count of invalid commands received */
+ uint8 ValidCmdCntr; /**< \mdtlmmnemonic \MD_CMDPC
+ \brief Count of valid commands received */
+ uint16 DwellEnabledMask; /**< \mdtlmmnemonic \MD_ENABLEMASK
+ \brief Each bit in bit mask enables a table
+ 0x0001=TBL1 enable bit,0x0002=TBL2 enable bit
+ 0x0004=TBL3 enable bit,0x0008=TBL4 enable bit, etc. */
+
uint16 DwellTblAddrCount[MD_NUM_DWELL_TABLES]; /**< \mdtlmmnemonic \MD_ADDRCNT
\brief Number of dwell addresses in table */
uint16 NumWaitsPerPkt[MD_NUM_DWELL_TABLES]; /**< \mdtlmmnemonic \MD_RATES
@@ -155,13 +159,14 @@ typedef struct
#define MD_HK_TLM_LNGTH sizeof(MD_HkTlm_t)
+
/**********************************/
/**
** \mdtlm Memory Dwell Telemetry Packet format
**/
typedef struct /* Actual Dwell information */
{
- uint8 TlmHeader[CFE_SB_TLM_HDR_SIZE]; /**< \brief cFE SB Tlm Msg Hdr */
+ CFE_SB_TlmHdr_t TlmHeader; /**< \brief cFE SB Tlm Msg Hdr */
uint8 TableId; /**< \mdtlmmnemonic \MD_TABLEID
\brief TableId from 1 to #MD_NUM_DWELL_TABLES */
@@ -176,7 +181,7 @@ typedef struct /* Actual Dwell information */
uint32 Rate; /**< \mdtlmmnemonic \MD_RATE \brief Number of counts between packet sends*/
#if MD_SIGNATURE_OPTION == 1
- char Signature[MD_SIGNATURE_FIELD_LENGTH];
+ char Signature[MD_SIGNATURE_FIELD_LENGTH];
/**< \mdtlmmnemonic \MD_SIGNATURE \brief Signature */
#endif
diff --git a/fsw/src/md_msgdefs.h b/fsw/src/md_msgdefs.h
index 20eba09..ad25a77 100644
--- a/fsw/src/md_msgdefs.h
+++ b/fsw/src/md_msgdefs.h
@@ -2,7 +2,7 @@
** File: md_msgdefs.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/src/md_tbldefs.h b/fsw/src/md_tbldefs.h
index c19ac4c..eb441f9 100644
--- a/fsw/src/md_tbldefs.h
+++ b/fsw/src/md_tbldefs.h
@@ -2,7 +2,7 @@
** File: md_tbldefs.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/src/md_utils.c b/fsw/src/md_utils.c
index 2833b46..b2cdf7a 100644
--- a/fsw/src/md_utils.c
+++ b/fsw/src/md_utils.c
@@ -2,7 +2,7 @@
** File: md_utils.c
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
@@ -36,10 +36,10 @@ extern MD_AppData_t MD_AppData;
/******************************************************************************/
-boolean MD_TableIsInMask(int16 TableId, uint16 TableMask)
+bool MD_TableIsInMask(int16 TableId, uint16 TableMask)
{
uint16 LocalMask = TableMask;
- boolean Status = FALSE;
+ bool Status = false;
/* Shift TableId - 1 times */
if (TableId - 1)
@@ -50,7 +50,7 @@ boolean MD_TableIsInMask(int16 TableId, uint16 TableMask)
/* If result is odd, */
/* then table is in mask. */
if ( (LocalMask & (uint16) 1) == (uint16) 1)
- Status = TRUE;
+ Status = true;
return Status;
@@ -93,14 +93,14 @@ void MD_UpdateDwellControlInfo (uint16 TableIndex)
** Data Validation Functions
*/
/******************************************************************************/
-boolean MD_ValidEntryId ( uint16 EntryId )
+bool MD_ValidEntryId ( uint16 EntryId )
{
- boolean IsValid = FALSE;
+ bool IsValid = false;
if ((EntryId >= 1) && ( EntryId <= MD_DWELL_TABLE_SIZE ))
{
/* validate value (1..MD_DWELL_TABLE_SIZE ) */
- IsValid = TRUE;
+ IsValid = true;
}
return IsValid;
@@ -109,25 +109,25 @@ boolean MD_ValidEntryId ( uint16 EntryId )
/******************************************************************************/
-boolean MD_ValidAddrRange( cpuaddr Addr, uint32 Size )
+bool MD_ValidAddrRange( cpuaddr Addr, uint32 Size )
{
- boolean IsValid = FALSE;
+ bool IsValid = false;
if ( CFE_PSP_MemValidateRange (Addr,Size, CFE_PSP_MEM_ANY) == OS_SUCCESS )
{
- IsValid = TRUE;
+ IsValid = true;
}
return IsValid;
}
/******************************************************************************/
-boolean MD_ValidTableId( uint16 TableId)
+bool MD_ValidTableId( uint16 TableId)
{
- boolean IsValid = FALSE;
+ bool IsValid = false;
if ((TableId >= 1) && (TableId <= MD_NUM_DWELL_TABLES))
{
- IsValid=TRUE;
+ IsValid=true;
}
return IsValid;
@@ -135,17 +135,17 @@ boolean MD_ValidTableId( uint16 TableId)
/******************************************************************************/
-boolean MD_ValidFieldLength( uint16 FieldLength)
+bool MD_ValidFieldLength( uint16 FieldLength)
{
- boolean IsValid = FALSE;
+ bool IsValid = false;
if ( (FieldLength == 0) ||
(FieldLength == 1) ||
(FieldLength == 2) ||
(FieldLength == 4) )
{
- IsValid= TRUE;
+ IsValid= true;
}
return IsValid;
diff --git a/fsw/src/md_utils.h b/fsw/src/md_utils.h
index 37033a8..f0414da 100644
--- a/fsw/src/md_utils.h
+++ b/fsw/src/md_utils.h
@@ -2,7 +2,7 @@
** File: md_utils.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
@@ -57,7 +57,7 @@
** \retstmt Returns TRUE or FALSE
** \endreturns
******************************************************************************/
-boolean MD_TableIsInMask(int16 TableId, uint16 TableMask);
+bool MD_TableIsInMask(int16 TableId, uint16 TableMask);
/*****************************************************************************/
/**
@@ -95,7 +95,7 @@ void MD_UpdateDwellControlInfo (uint16 TableIndex);
** \endreturns
**
******************************************************************************/
-boolean MD_ValidEntryId ( uint16 EntryId );
+bool MD_ValidEntryId ( uint16 EntryId );
/*****************************************************************************/
/**
@@ -117,7 +117,7 @@ boolean MD_ValidEntryId ( uint16 EntryId );
** \endreturns
**
******************************************************************************/
-boolean MD_ValidAddrRange( cpuaddr Addr, uint32 Size );
+bool MD_ValidAddrRange( cpuaddr Addr, uint32 Size );
/*****************************************************************************/
/**
@@ -139,7 +139,7 @@ boolean MD_ValidAddrRange( cpuaddr Addr, uint32 Size );
** \endreturns
**
******************************************************************************/
-boolean MD_ValidTableId( uint16 TableId );
+bool MD_ValidTableId( uint16 TableId );
/*****************************************************************************/
/**
@@ -159,7 +159,7 @@ boolean MD_ValidTableId( uint16 TableId );
** \endreturns
**
******************************************************************************/
-boolean MD_ValidFieldLength(uint16 FieldLength);
+bool MD_ValidFieldLength(uint16 FieldLength);
diff --git a/fsw/src/md_verify.h b/fsw/src/md_verify.h
index 8859589..3e11a89 100644
--- a/fsw/src/md_verify.h
+++ b/fsw/src/md_verify.h
@@ -2,7 +2,7 @@
** File: md_verify.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
@@ -55,7 +55,7 @@
/* will be too large for Table Services */
#if MD_DWELL_TABLE_SIZE < 1
#error MD_DWELL_TABLE_SIZE must be at least one.
-#elif MD_NUM_DWELL_TABLES > 65535
+#elif MD_DWELL_TABLE_SIZE > 65535
#error MD_DWELL_TABLE_SIZE cannot be greater than 65535.
#endif
diff --git a/fsw/src/md_version.h b/fsw/src/md_version.h
index 493dd4a..ac1fd7c 100644
--- a/fsw/src/md_version.h
+++ b/fsw/src/md_version.h
@@ -2,7 +2,7 @@
** File: md_version.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
@@ -31,7 +31,7 @@
#define MD_MAJOR_VERSION 2
#define MD_MINOR_VERSION 3
-#define MD_REVISION 2
+#define MD_REVISION 3
#endif /* _md_version_h_ */
diff --git a/fsw/tables/md_dw01.c b/fsw/tables/md_dw01.c
index 671f847..488a5e3 100644
--- a/fsw/tables/md_dw01.c
+++ b/fsw/tables/md_dw01.c
@@ -2,7 +2,7 @@
** File: md_dw01.c
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/tables/md_dw02.c b/fsw/tables/md_dw02.c
index 645adc2..dedfac6 100644
--- a/fsw/tables/md_dw02.c
+++ b/fsw/tables/md_dw02.c
@@ -2,7 +2,7 @@
** File: md_dw02.c
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/tables/md_dw03.c b/fsw/tables/md_dw03.c
index 68a50d0..8ec87a9 100644
--- a/fsw/tables/md_dw03.c
+++ b/fsw/tables/md_dw03.c
@@ -2,7 +2,7 @@
** File: md_dw03.c
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/tables/md_dw04.c b/fsw/tables/md_dw04.c
index 3cd3eca..70b574b 100644
--- a/fsw/tables/md_dw04.c
+++ b/fsw/tables/md_dw04.c
@@ -2,7 +2,7 @@
** File: md_dw04.c
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/unit_test/md_app_test.c b/fsw/unit_test/md_app_test.c
index 1ac7eb0..c1a6ca9 100644
--- a/fsw/unit_test/md_app_test.c
+++ b/fsw/unit_test/md_app_test.c
@@ -2,7 +2,7 @@
** File: md_app_test.c
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
- ** Memory Dwell Application Version 2.3.2”
+ ** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/unit_test/md_app_test.h b/fsw/unit_test/md_app_test.h
index 8fde889..3938c4f 100644
--- a/fsw/unit_test/md_app_test.h
+++ b/fsw/unit_test/md_app_test.h
@@ -2,7 +2,7 @@
** File: md_app_test.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
- ** Memory Dwell Application Version 2.3.2”
+ ** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/unit_test/md_cmds_test.c b/fsw/unit_test/md_cmds_test.c
index f755b80..d6facb3 100644
--- a/fsw/unit_test/md_cmds_test.c
+++ b/fsw/unit_test/md_cmds_test.c
@@ -2,7 +2,7 @@
** File: md_cmds_test.c
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
- ** Memory Dwell Application Version 2.3.2”
+ ** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/unit_test/md_cmds_test.h b/fsw/unit_test/md_cmds_test.h
index 907ace9..89bce69 100644
--- a/fsw/unit_test/md_cmds_test.h
+++ b/fsw/unit_test/md_cmds_test.h
@@ -2,7 +2,7 @@
** File: md_cmds_test.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
- ** Memory Dwell Application Version 2.3.2”
+ ** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/unit_test/md_dwell_pkt_test.c b/fsw/unit_test/md_dwell_pkt_test.c
index 034227e..52109a0 100644
--- a/fsw/unit_test/md_dwell_pkt_test.c
+++ b/fsw/unit_test/md_dwell_pkt_test.c
@@ -2,7 +2,7 @@
** File: md_dwell_pkt_test.c
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
- ** Memory Dwell Application Version 2.3.2”
+ ** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/unit_test/md_dwell_pkt_test.h b/fsw/unit_test/md_dwell_pkt_test.h
index 5122c94..19719be 100644
--- a/fsw/unit_test/md_dwell_pkt_test.h
+++ b/fsw/unit_test/md_dwell_pkt_test.h
@@ -2,7 +2,7 @@
** File: md_dwell_pkt_test.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
- ** Memory Dwell Application Version 2.3.2”
+ ** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/unit_test/md_dwell_tbl_test.c b/fsw/unit_test/md_dwell_tbl_test.c
index 31307eb..7a95d65 100644
--- a/fsw/unit_test/md_dwell_tbl_test.c
+++ b/fsw/unit_test/md_dwell_tbl_test.c
@@ -2,7 +2,7 @@
** File: md_dwell_tbl_test.c
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
- ** Memory Dwell Application Version 2.3.2”
+ ** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/unit_test/md_dwell_tbl_test.h b/fsw/unit_test/md_dwell_tbl_test.h
index c3725f0..dd58e75 100644
--- a/fsw/unit_test/md_dwell_tbl_test.h
+++ b/fsw/unit_test/md_dwell_tbl_test.h
@@ -2,7 +2,7 @@
** File: md_dwell_tbl_test.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
- ** Memory Dwell Application Version 2.3.2”
+ ** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/unit_test/md_platform_cfg.h b/fsw/unit_test/md_platform_cfg.h
index 07ea39d..9203e50 100644
--- a/fsw/unit_test/md_platform_cfg.h
+++ b/fsw/unit_test/md_platform_cfg.h
@@ -2,7 +2,7 @@
** File: md_platform_cfg.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
-** Memory Dwell Application Version 2.3.2”
+** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/unit_test/md_test_utils.c b/fsw/unit_test/md_test_utils.c
index b542000..dbff772 100644
--- a/fsw/unit_test/md_test_utils.c
+++ b/fsw/unit_test/md_test_utils.c
@@ -2,7 +2,7 @@
** File: md_test_utils.c
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
- ** Memory Dwell Application Version 2.3.2”
+ ** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/unit_test/md_test_utils.h b/fsw/unit_test/md_test_utils.h
index bf04861..b3333c0 100644
--- a/fsw/unit_test/md_test_utils.h
+++ b/fsw/unit_test/md_test_utils.h
@@ -2,7 +2,7 @@
** File: md_test_utils.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
- ** Memory Dwell Application Version 2.3.2”
+ ** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/unit_test/md_testrunner.c b/fsw/unit_test/md_testrunner.c
index e55d630..e0b35f3 100644
--- a/fsw/unit_test/md_testrunner.c
+++ b/fsw/unit_test/md_testrunner.c
@@ -2,7 +2,7 @@
** File: md_testrunner.c
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
- ** Memory Dwell Application Version 2.3.2”
+ ** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/unit_test/md_utils_test.c b/fsw/unit_test/md_utils_test.c
index 4d17bd0..5eaa5e9 100644
--- a/fsw/unit_test/md_utils_test.c
+++ b/fsw/unit_test/md_utils_test.c
@@ -2,7 +2,7 @@
** File: md_utils_test.c
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
- ** Memory Dwell Application Version 2.3.2”
+ ** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/fsw/unit_test/md_utils_test.h b/fsw/unit_test/md_utils_test.h
index cd84b38..a01ecf9 100644
--- a/fsw/unit_test/md_utils_test.h
+++ b/fsw/unit_test/md_utils_test.h
@@ -2,7 +2,7 @@
** File: md_utils_test.h
**
** NASA Docket No. GSC-18,450-1, identified as “Core Flight Software System (CFS)
- ** Memory Dwell Application Version 2.3.2”
+ ** Memory Dwell Application Version 2.3.3”
**
** Copyright © 2019 United States Government as represented by the Administrator of
** the National Aeronautics and Space Administration. All Rights Reserved.
diff --git a/md_config.txt b/md_config.txt
new file mode 100644
index 0000000..aa582b3
--- /dev/null
+++ b/md_config.txt
@@ -0,0 +1,2575 @@
+# Doxyfile 1.8.16
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project.
+#
+# All text after a double hash (##) is considered a comment and is placed in
+# front of the TAG it is preceding.
+#
+# All text after a single hash (#) is considered a comment and will be ignored.
+# The format is:
+# TAG = value [value, ...]
+# For lists, items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (\" \").
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the configuration
+# file that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
+# The default value is: UTF-8.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
+# double-quotes, unless you are using Doxywizard) that should identify the
+# project for which the documentation is generated. This name is used in the
+# title of most generated pages and in a few other places.
+# The default value is: My Project.
+
+PROJECT_NAME = "cFS_MD"
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
+# could be handy for archiving the generated documentation or if some version
+# control system is used.
+
+PROJECT_NUMBER =
+
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
+# for a project that appears at the top of each page and should give viewer a
+# quick idea about the purpose of the project. Keep the description short.
+PROJECT_BRIEF =
+
+
+# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
+# in the documentation. The maximum height of the logo should not exceed 55
+# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
+# the logo to the output directory.
+
+PROJECT_LOGO =
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
+# into which the generated documentation will be written. If a relative path is
+# entered, it will be relative to the location where doxygen was started. If
+# left blank the current directory will be used.
+
+OUTPUT_DIRECTORY = cfs_md_user_guide
+
+# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
+# directories (in 2 levels) under the output directory of each output format and
+# will distribute the generated files over these directories. Enabling this
+# option can be useful when feeding doxygen a huge amount of source files, where
+# putting all generated files in the same directory would otherwise causes
+# performance problems for the file system.
+# The default value is: NO.
+
+CREATE_SUBDIRS = NO
+
+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
+# characters to appear in the names of generated files. If set to NO, non-ASCII
+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
+# U+3044.
+# The default value is: NO.
+
+ALLOW_UNICODE_NAMES = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
+# Ukrainian and Vietnamese.
+# The default value is: English.
+
+OUTPUT_LANGUAGE = English
+
+# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all generated output in the proper direction.
+# Possible values are: None, LTR, RTL and Context.
+# The default value is: None.
+
+OUTPUT_TEXT_DIRECTION = None
+
+# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
+# descriptions after the members that are listed in the file and class
+# documentation (similar to Javadoc). Set to NO to disable this.
+# The default value is: YES.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
+# description of a member or function before the detailed description
+#
+# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+# The default value is: YES.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator that is
+# used to form the text in various listings. Each string in this list, if found
+# as the leading text of the brief description, will be stripped from the text
+# and the result, after processing the whole list, is used as the annotated
+# text. Otherwise, the brief description is used as-is. If left blank, the
+# following values are used ($name is automatically replaced with the name of
+# the entity):The $name class, The $name widget, The $name file, is, provides,
+# specifies, contains, represents, a, an and the.
+
+ABBREVIATE_BRIEF = "The $name class" \
+ "The $name widget" \
+ "The $name file" \
+ is \
+ provides \
+ specifies \
+ contains \
+ represents \
+ a \
+ an \
+ the
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# doxygen will generate a detailed section even if there is only a brief
+# description.
+# The default value is: NO.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+# The default value is: NO.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
+# before files name in the file list and in the header files. If set to NO the
+# shortest path that makes the file name unique will be used
+# The default value is: YES.
+
+FULL_PATH_NAMES = YES
+
+# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
+# Stripping is only done if one of the specified strings matches the left-hand
+# part of the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the path to
+# strip.
+#
+# Note that you can specify absolute paths here, but also relative paths, which
+# will be relative from the directory where doxygen is started.
+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
+# path mentioned in the documentation of a class, which tells the reader which
+# header file to include in order to use a class. If left blank only the name of
+# the header file containing the class definition is used. Otherwise one should
+# specify the list of include paths that are normally passed to the compiler
+# using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
+# less readable) file names. This can be useful is your file systems doesn't
+# support long names like on DOS, Mac, or CD-ROM.
+# The default value is: NO.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
+# first line (until the first dot) of a Javadoc-style comment as the brief
+# description. If set to NO, the Javadoc-style will behave just like regular Qt-
+# style comments (thus requiring an explicit @brief command for a brief
+# description.)
+# The default value is: NO.
+
+JAVADOC_AUTOBRIEF = NO
+
+# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
+# such as
+# /***************
+# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
+# Javadoc-style will behave just like regular comments and it will not be
+# interpreted by doxygen.
+# The default value is: NO.
+
+JAVADOC_BANNER = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
+# line (until the first dot) of a Qt-style comment as the brief description. If
+# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
+# requiring an explicit \brief command for a brief description.)
+# The default value is: NO.
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
+# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
+# a brief description. This used to be the default behavior. The new default is
+# to treat a multi-line C++ comment block as a detailed description. Set this
+# tag to YES if you prefer the old behavior instead.
+#
+# Note that setting this tag to YES also means that rational rose comments are
+# not recognized any more.
+# The default value is: NO.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
+# documentation from any documented member that it re-implements.
+# The default value is: YES.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
+# page for each member. If set to NO, the documentation of a member will be part
+# of the file/class/namespace that contains it.
+# The default value is: NO.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
+# uses this value to replace tabs by spaces in code fragments.
+# Minimum value: 1, maximum value: 16, default value: 4.
+
+TAB_SIZE = 4
+
+# This tag can be used to specify a number of aliases that act as commands in
+# the documentation. An alias has the form:
+# name=value
+# For example adding
+# "sideeffect=@par Side Effects:\n"
+# will allow you to put the command \sideeffect (or @sideeffect) in the
+# documentation, which will result in a user-defined paragraph with heading
+# "Side Effects:". You can put \n's in the value part of an alias to insert
+# newlines (in the resulting output). You can put ^^ in the value part of an
+# alias to insert a newline as if a physical newline was in the original file.
+# When you need a literal { or } or , in the value part of an alias you have to
+# escape them by means of a backslash (\), this can lead to conflicts with the
+# commands \{ and \} for these it is advised to use the version @{ and @} or use
+# a double escape (\\{ and \\})
+
+ALIASES += "event=\xrefitem mdevents \"Event Message\" \"MD Event Message Cross Reference\" " \
+ "mdcfg=\xrefitem cfsmdcfg \"Purpose\" \"MD Configuration Parameters\" " \
+ "mdcmd=\xrefitem cfsmdcmds \"Purpose\" \"MD Command Reference\" " \
+ "mdtlm=\xrefitem cfsmdtlm \"Purpose\" \"MD Telemetry Reference\" " \
+ "mdtlmmnemonic=\xrefitem mdtlmmnems \"Telemetry Mnemonic(s)\" \"MD Telemetry Mnemonic Cross Reference\" "
+
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding "class=itcl::class"
+# will allow you to use the command class in the itcl::class meaning.
+
+TCL_SUBST =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+# only. Doxygen will then generate output that is more tailored for C. For
+# instance, some of the names that are used will be different. The list of all
+# members will be omitted, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_FOR_C = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
+# Python sources only. Doxygen will then generate output that is more tailored
+# for that language. For instance, namespaces will be presented as packages,
+# qualified scopes will look different, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources. Doxygen will then generate output that is tailored for Fortran.
+# The default value is: NO.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for VHDL.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
+# sources only. Doxygen will then generate output that is more tailored for that
+# language. For instance, namespaces will be presented as modules, types will be
+# separated into more groups, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_SLICE = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it
+# parses. With this tag you can assign which parser to use for a given
+# extension. Doxygen has a built-in mapping, but you can override or extend it
+# using this tag. The format is ext=language, where ext is a file extension, and
+# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
+# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
+# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
+# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
+# tries to guess whether the code is fixed or free formatted code, this is the
+# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat
+# .inc files as Fortran files (default is PHP), and .f files as C (default is
+# Fortran), use: inc=Fortran f=C.
+#
+# Note: For files without extension you can use no_extension as a placeholder.
+#
+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
+# the files are not read by doxygen.
+
+EXTENSION_MAPPING =
+
+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
+# according to the Markdown format, which allows for more readable
+# documentation. See https://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you can
+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
+# case of backward compatibilities issues.
+# The default value is: YES.
+
+MARKDOWN_SUPPORT = YES
+
+# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
+# to that level are automatically included in the table of contents, even if
+# they do not have an id attribute.
+# Note: This feature currently applies only to Markdown headings.
+# Minimum value: 0, maximum value: 99, default value: 5.
+# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
+
+TOC_INCLUDE_HEADINGS = 5
+
+# When enabled doxygen tries to link words that correspond to documented
+# classes, or namespaces to their corresponding documentation. Such a link can
+# be prevented in individual cases by putting a % sign in front of the word or
+# globally by setting AUTOLINK_SUPPORT to NO.
+# The default value is: YES.
+
+AUTOLINK_SUPPORT = YES
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should set this
+# tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string);
+# versus func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+# The default value is: NO.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+# The default value is: NO.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
+# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
+# will parse them like normal C++ but will assume all classes use public instead
+# of private inheritance when no explicit protection keyword is present.
+# The default value is: NO.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate
+# getter and setter methods for a property. Setting this option to YES will make
+# doxygen to replace the get and set methods by a property in the documentation.
+# This will only work if the methods are indeed getting or setting a simple
+# type. If this is not the case, or you want to show the methods anyway, you
+# should set this option to NO.
+# The default value is: YES.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+# The default value is: NO.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# If one adds a struct or class to a group and this option is enabled, then also
+# any nested class or struct is added to the same group. By default this option
+# is disabled and one has to add nested compounds explicitly via \ingroup.
+# The default value is: NO.
+
+GROUP_NESTED_COMPOUNDS = NO
+
+# Set the SUBGROUPING tag to YES to allow class member groups of the same type
+# (for instance a group of public functions) to be put as a subgroup of that
+# type (e.g. under the Public Functions section). Set it to NO to prevent
+# subgrouping. Alternatively, this can be done per class using the
+# \nosubgrouping command.
+# The default value is: YES.
+
+SUBGROUPING = YES
+
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
+# are shown inside the group in which they are included (e.g. using \ingroup)
+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
+# and RTF).
+#
+# Note that this feature does not work in combination with
+# SEPARATE_MEMBER_PAGES.
+# The default value is: NO.
+
+INLINE_GROUPED_CLASSES = NO
+
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
+# with only public data fields or simple typedef fields will be shown inline in
+# the documentation of the scope in which they are defined (i.e. file,
+# namespace, or group documentation), provided this scope is documented. If set
+# to NO, structs, classes, and unions are shown on a separate page (for HTML and
+# Man pages) or section (for LaTeX and RTF).
+# The default value is: NO.
+
+INLINE_SIMPLE_STRUCTS = NO
+
+# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
+# enum is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically be
+# useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+# The default value is: NO.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
+# cache is used to resolve symbols given their name and scope. Since this can be
+# an expensive process and often the same symbol appears multiple times in the
+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
+# doxygen will become slower. If the cache is too large, memory is wasted. The
+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
+# symbols. At the end of a run doxygen will report the cache usage and suggest
+# the optimal cache size from a speed point of view.
+# Minimum value: 0, maximum value: 9, default value: 0.
+
+LOOKUP_CACHE_SIZE = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
+# documentation are documented, even if no documentation was available. Private
+# class members and static file members will be hidden unless the
+# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
+# Note: This will also disable the warnings about undocumented members that are
+# normally produced when WARNINGS is set to YES.
+# The default value is: NO.
+
+EXTRACT_ALL = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
+# be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PRIVATE = YES
+
+# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
+# methods of a class will be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PRIV_VIRTUAL = NO
+
+# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
+# scope will be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PACKAGE = NO
+
+# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
+# included in the documentation.
+# The default value is: NO.
+
+EXTRACT_STATIC = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
+# locally in source files will be included in the documentation. If set to NO,
+# only classes defined in header files are included. Does not have any effect
+# for Java sources.
+# The default value is: YES.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. If set to YES, local methods,
+# which are defined in the implementation section but not in the interface are
+# included in the documentation. If set to NO, only methods in the interface are
+# included.
+# The default value is: NO.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base name of
+# the file that contains the anonymous namespace. By default anonymous namespace
+# are hidden.
+# The default value is: NO.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
+# undocumented members inside documented classes or files. If set to NO these
+# members will be included in the various overviews, but no documentation
+# section is generated. This option has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy. If set
+# to NO, these classes will be included in the various overviews. This option
+# has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
+# (class|struct|union) declarations. If set to NO, these declarations will be
+# included in the documentation.
+# The default value is: NO.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
+# documentation blocks found inside the body of a function. If set to NO, these
+# blocks will be appended to the function's detailed documentation block.
+# The default value is: NO.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation that is typed after a
+# \internal command is included. If the tag is set to NO then the documentation
+# will be excluded. Set it to YES to include the internal documentation.
+# The default value is: NO.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
+# names in lower-case letters. If set to YES, upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# (including Cygwin) ands Mac users are advised to set this option to NO.
+# The default value is: system dependent.
+
+CASE_SENSE_NAMES = NO
+
+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
+# their full class and namespace scopes in the documentation. If set to YES, the
+# scope will be hidden.
+# The default value is: NO.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
+# append additional text to a page's title, such as Class Reference. If set to
+# YES the compound reference will be hidden.
+# The default value is: NO.
+
+HIDE_COMPOUND_REFERENCE= NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
+# the files that are included by a file in the documentation of that file.
+# The default value is: YES.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
+# grouped member an include statement to the documentation, telling the reader
+# which file to include in order to use the member.
+# The default value is: NO.
+
+SHOW_GROUPED_MEMB_INC = NO
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
+# files with double quotes in the documentation rather than with sharp brackets.
+# The default value is: NO.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
+# documentation for inline members.
+# The default value is: YES.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
+# (detailed) documentation of file and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order.
+# The default value is: YES.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
+# descriptions of file, namespace and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order. Note that
+# this will also influence the order of the classes in the class list.
+# The default value is: NO.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
+# (brief and detailed) documentation of class members so that constructors and
+# destructors are listed first. If set to NO the constructors will appear in the
+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
+# member documentation.
+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
+# detailed member documentation.
+# The default value is: NO.
+
+SORT_MEMBERS_CTORS_1ST = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
+# of group names into alphabetical order. If set to NO the group names will
+# appear in their defined order.
+# The default value is: NO.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
+# fully-qualified names, including namespaces. If set to NO, the class list will
+# be sorted only by class name, not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the alphabetical
+# list.
+# The default value is: NO.
+
+SORT_BY_SCOPE_NAME = NO
+
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
+# type resolution of all parameters of a function it will reject a match between
+# the prototype and the implementation of a member function even if there is
+# only one candidate or it is obvious which candidate to choose by doing a
+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
+# accept a match between prototype and implementation in such cases.
+# The default value is: NO.
+
+STRICT_PROTO_MATCHING = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
+# list. This list is created by putting \todo commands in the documentation.
+# The default value is: YES.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
+# list. This list is created by putting \test commands in the documentation.
+# The default value is: YES.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
+# list. This list is created by putting \bug commands in the documentation.
+# The default value is: YES.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
+# the deprecated list. This list is created by putting \deprecated commands in
+# the documentation.
+# The default value is: YES.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional documentation
+# sections, marked by \if ... \endif and \cond
+# ... \endcond blocks.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
+# initial value of a variable or macro / define can have for it to appear in the
+# documentation. If the initializer consists of more lines than specified here
+# it will be hidden. Use a value of 0 to hide initializers completely. The
+# appearance of the value of individual variables and macros / defines can be
+# controlled using \showinitializer or \hideinitializer command in the
+# documentation regardless of this setting.
+# Minimum value: 0, maximum value: 10000, default value: 30.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
+# the bottom of the documentation of classes and structs. If set to YES, the
+# list will mention the files that were used to generate the documentation.
+# The default value is: YES.
+
+SHOW_USED_FILES = YES
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
+# will remove the Files entry from the Quick Index and from the Folder Tree View
+# (if specified).
+# The default value is: YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
+# page. This will remove the Namespaces entry from the Quick Index and from the
+# Folder Tree View (if specified).
+# The default value is: YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command command input-file, where command is the value of the
+# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
+# by doxygen. Whatever the program writes to standard output is used as the file
+# version. For an example see the documentation.
+
+FILE_VERSION_FILTER =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
+# by doxygen. The layout file controls the global structure of the generated
+# output files in an output format independent way. To create the layout file
+# that represents doxygen's defaults, run doxygen with the -l option. You can
+# optionally specify a file name after the option, if omitted DoxygenLayout.xml
+# will be used as the name of the layout file.
+#
+# Note that if you run doxygen from a directory containing a file called
+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
+# tag is left empty.
+
+LAYOUT_FILE =
+
+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
+# the reference definitions. This must be a list of .bib files. The .bib
+# extension is automatically appended if omitted. This requires the bibtex tool
+# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
+# For LaTeX the style of the bibliography can be controlled using
+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
+# search path. See also \cite for info how to create references.
+
+CITE_BIB_FILES =
+
+#---------------------------------------------------------------------------
+# Configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated to
+# standard output by doxygen. If QUIET is set to YES this implies that the
+# messages are off.
+# The default value is: NO.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
+# this implies that the warnings are on.
+#
+# Tip: Turn warnings on while writing the documentation.
+# The default value is: YES.
+
+WARNINGS = YES
+
+# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
+# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
+# will automatically be disabled.
+# The default value is: YES.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some parameters
+# in a documented function, or documenting parameters that don't exist or using
+# markup commands wrongly.
+# The default value is: YES.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
+# are documented, but have no documentation for their parameters or return
+# value. If set to NO, doxygen will only warn about wrong or incomplete
+# parameter documentation, but not about the absence of documentation. If
+# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
+# The default value is: NO.
+
+WARN_NO_PARAMDOC = YES
+
+# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
+# a warning is encountered.
+# The default value is: NO.
+
+WARN_AS_ERROR = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that doxygen
+# can produce. The string should contain the $file, $line, and $text tags, which
+# will be replaced by the file and line number from which the warning originated
+# and the warning text. Optionally the format may contain $version, which will
+# be replaced by the version of the file (if it could be obtained via
+# FILE_VERSION_FILTER)
+# The default value is: $file:$line: $text.
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning and error
+# messages should be written. If left blank the output is written to standard
+# error (stderr).
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag is used to specify the files and/or directories that contain
+# documented source files. You may enter file names like myfile.cpp or
+# directories like /usr/src/myproject. Separate the files or directories with
+# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
+# Note: If this tag is empty the current directory is searched.
+
+INPUT = fsw/
+
+INPUT += docs/dox_src/users_guide
+
+INPUT += docs/dox_src/mnem_maps
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
+# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
+# possible encodings.
+# The default value is: UTF-8.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
+# *.h) to filter out the source-files in the directories.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# read by doxygen.
+#
+# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
+# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
+# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
+# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
+# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
+
+FILE_PATTERNS = *.c \
+ *.cc \
+ *.cxx \
+ *.cpp \
+ *.c++ \
+ *.java \
+ *.ii \
+ *.ixx \
+ *.ipp \
+ *.i++ \
+ *.inl \
+ *.idl \
+ *.ddl \
+ *.odl \
+ *.h \
+ *.hh \
+ *.hxx \
+ *.hpp \
+ *.h++ \
+ *.cs \
+ *.d \
+ *.php \
+ *.php4 \
+ *.php5 \
+ *.phtml \
+ *.inc \
+ *.m \
+ *.markdown \
+ *.md \
+ *.mm \
+ *.dox \
+ *.py \
+ *.pyw \
+ *.f90 \
+ *.f95 \
+ *.f03 \
+ *.f08 \
+ *.f \
+ *.for \
+ *.tcl \
+ *.vhd \
+ *.vhdl \
+ *.ucf \
+ *.qsf \
+ *.ice
+
+# The RECURSIVE tag can be used to specify whether or not subdirectories should
+# be searched for input files as well.
+# The default value is: NO.
+
+RECURSIVE = YES
+
+# The EXCLUDE tag can be used to specify files and/or directories that should be
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+#
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
+
+EXCLUDE = unit_test
+
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
+# directories that are symbolic links (a Unix file system feature) are excluded
+# from the input.
+# The default value is: NO.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories.
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories use the pattern */test/*
+
+EXCLUDE_SYMBOLS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or directories
+# that contain example code fragments that are included (see the \include
+# command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank all
+# files are included.
+
+EXAMPLE_PATTERNS = *
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude commands
+# irrespective of the value of the RECURSIVE tag.
+# The default value is: NO.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or directories
+# that contain images that are to be included in the documentation (see the
+# \image command).
+
+IMAGE_PATH = docs/dox_src/users_guide
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command:
+#
+#
+#
+# where is the value of the INPUT_FILTER tag, and is the
+# name of an input file. Doxygen will then use the output that the filter
+# program writes to standard output. If FILTER_PATTERNS is specified, this tag
+# will be ignored.
+#
+# Note that the filter must not add or remove lines; it is applied before the
+# code is scanned, but not when the output code is generated. If lines are added
+# or removed, the anchors will not be placed correctly.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form: pattern=filter
+# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
+# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
+# patterns match the file name, INPUT_FILTER is applied.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will also be used to filter the input files that are used for
+# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
+# The default value is: NO.
+
+FILTER_SOURCE_FILES = NO
+
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
+# it is also possible to disable source filtering for a specific pattern using
+# *.ext= (so without naming a filter).
+# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
+
+FILTER_SOURCE_PATTERNS =
+
+# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
+# is part of the input, its contents will be placed on the main page
+# (index.html). This can be useful if you have a project on for instance GitHub
+# and want to reuse the introduction page also for the doxygen output.
+
+USE_MDFILE_AS_MAINPAGE = readme.md
+
+#---------------------------------------------------------------------------
+# Configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
+# generated. Documented entities will be cross-referenced with these sources.
+#
+# Note: To get rid of all source code in the generated output, make sure that
+# also VERBATIM_HEADERS is set to NO.
+# The default value is: NO.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body of functions,
+# classes and enums directly into the documentation.
+# The default value is: NO.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
+# special comment blocks from generated source code fragments. Normal C, C++ and
+# Fortran comments will always remain visible.
+# The default value is: YES.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
+# entity all documented functions referencing it will be listed.
+# The default value is: NO.
+
+REFERENCED_BY_RELATION = NO
+
+# If the REFERENCES_RELATION tag is set to YES then for each documented function
+# all documented entities called/used by that function will be listed.
+# The default value is: NO.
+
+REFERENCES_RELATION = NO
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
+# to YES then the hyperlinks from functions in REFERENCES_RELATION and
+# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
+# link to the documentation.
+# The default value is: YES.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
+# source code will show a tooltip with additional information such as prototype,
+# brief description and links to the definition and documentation. Since this
+# will make the HTML file larger and loading of large files a bit slower, you
+# can opt to disable this feature.
+# The default value is: YES.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+SOURCE_TOOLTIPS = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code will
+# point to the HTML generated by the htags(1) tool instead of doxygen built-in
+# source browser. The htags tool is part of GNU's global source tagging system
+# (see https://www.gnu.org/software/global/global.html). You will need version
+# 4.8.6 or higher.
+#
+# To use it do the following:
+# - Install the latest version of global
+# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
+# - Make sure the INPUT points to the root of the source tree
+# - Run doxygen as normal
+#
+# Doxygen will invoke htags (and that will in turn invoke gtags), so these
+# tools must be available from the command line (i.e. in the search path).
+#
+# The result: instead of the source browser generated by doxygen, the links to
+# source code will now point to the output of htags.
+# The default value is: NO.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
+# verbatim copy of the header file for each class for which an include is
+# specified. Set to NO to disable this.
+# See also: Section \class.
+# The default value is: YES.
+
+VERBATIM_HEADERS = YES
+
+# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
+# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
+# cost of reduced performance. This can be particularly helpful with template
+# rich C++ code for which doxygen's built-in parser lacks the necessary type
+# information.
+# Note: The availability of this option depends on whether or not doxygen was
+# generated with the -Duse_libclang=ON option for CMake.
+# The default value is: NO.
+
+CLANG_ASSISTED_PARSING = NO
+
+# If clang assisted parsing is enabled you can provide the compiler with command
+# line options that you would normally use when invoking the compiler. Note that
+# the include paths will already be set by doxygen for the files and directories
+# specified with INPUT and INCLUDE_PATH.
+# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
+
+CLANG_OPTIONS =
+
+# If clang assisted parsing is enabled you can provide the clang parser with the
+# path to the compilation database (see:
+# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
+# were built. This is equivalent to specifying the "-p" option to a clang tool,
+# such as clang-check. These options will then be passed to the parser.
+# Note: The availability of this option depends on whether or not doxygen was
+# generated with the -Duse_libclang=ON option for CMake.
+
+CLANG_DATABASE_PATH =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
+# compounds will be generated. Enable this if the project contains a lot of
+# classes, structs, unions or interfaces.
+# The default value is: YES.
+
+ALPHABETICAL_INDEX = YES
+
+# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
+# which the alphabetical index list will be split.
+# Minimum value: 1, maximum value: 20, default value: 5.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all classes will
+# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
+# can be used to specify a prefix (or a list of prefixes) that should be ignored
+# while generating the index headers.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
+# The default value is: YES.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
+# generated HTML page (for example: .htm, .php, .asp).
+# The default value is: .html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
+# each generated HTML page. If the tag is left blank doxygen will generate a
+# standard header.
+#
+# To get valid HTML the header file that includes any scripts and style sheets
+# that doxygen needs, which is dependent on the configuration options used (e.g.
+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
+# default header using
+# doxygen -w html new_header.html new_footer.html new_stylesheet.css
+# YourConfigFile
+# and then modify the file new_header.html. See also section "Doxygen usage"
+# for information on how to generate the default header that doxygen normally
+# uses.
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. For a description
+# of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
+# generated HTML page. If the tag is left blank doxygen will generate a standard
+# footer. See HTML_HEADER for more information on how to generate a default
+# footer and what special commands can be used inside the footer. See also
+# section "Doxygen usage" for information on how to generate the default footer
+# that doxygen normally uses.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
+# sheet that is used by each HTML page. It can be used to fine-tune the look of
+# the HTML output. If left blank doxygen will generate a default style sheet.
+# See also section "Doxygen usage" for information on how to generate the style
+# sheet that doxygen normally uses.
+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
+# it is more robust and this tag (HTML_STYLESHEET) will in the future become
+# obsolete.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_STYLESHEET =
+
+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# cascading style sheets that are included after the standard style sheets
+# created by doxygen. Using this option one can overrule certain style aspects.
+# This is preferred over using HTML_STYLESHEET since it does not replace the
+# standard style sheet and is therefore more robust against future updates.
+# Doxygen will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list). For an example see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_STYLESHEET =
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
+# files will be copied as-is; there are no commands or markers available.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_FILES =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
+# will adjust the colors in the style sheet and background images according to
+# this color. Hue is specified as an angle on a colorwheel, see
+# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
+# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
+# purple, and 360 is red again.
+# Minimum value: 0, maximum value: 359, default value: 220.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_HUE = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
+# in the HTML output. For a value of 0 the output will use grayscales only. A
+# value of 255 will produce the most vivid colors.
+# Minimum value: 0, maximum value: 255, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_SAT = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
+# luminance component of the colors in the HTML output. Values below 100
+# gradually make the output lighter, whereas values above 100 make the output
+# darker. The value divided by 100 is the actual gamma applied, so 80 represents
+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
+# change the gamma.
+# Minimum value: 40, maximum value: 240, default value: 80.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_GAMMA = 80
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting this
+# to YES can help to show when doxygen was last run and thus if the
+# documentation is up to date.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_TIMESTAMP = NO
+
+# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
+# documentation will contain a main index with vertical navigation menus that
+# are dynamically created via Javascript. If disabled, the navigation index will
+# consists of multiple levels of tabs that are statically embedded in every HTML
+# page. Disable this option to support browsers that do not have Javascript,
+# like the Qt help browser.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_DYNAMIC_MENUS = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
+# shown in the various tree structured indices initially; the user can expand
+# and collapse entries dynamically later on. Doxygen will expand the tree to
+# such a level that at most the specified number of entries are visible (unless
+# a fully collapsed tree already exceeds this amount). So setting the number of
+# entries 1 will produce a full collapsed tree by default. 0 is a special value
+# representing an infinite number of entries and will result in a full expanded
+# tree by default.
+# Minimum value: 0, maximum value: 9999, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_INDEX_NUM_ENTRIES = 100
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files will be
+# generated that can be used as input for Apple's Xcode 3 integrated development
+# environment (see: https://developer.apple.com/xcode/), introduced with OSX
+# 10.5 (Leopard). To create a documentation set, doxygen will generate a
+# Makefile in the HTML output directory. Running make will produce the docset in
+# that directory and running make install will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
+# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
+# genXcode/_index.html for more information.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_DOCSET = NO
+
+# This tag determines the name of the docset feed. A documentation feed provides
+# an umbrella under which multiple documentation sets from a single provider
+# (such as a company or product suite) can be grouped.
+# The default value is: Doxygen generated docs.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# This tag specifies a string that should uniquely identify the documentation
+# set bundle. This should be a reverse domain-name style string, e.g.
+# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+# The default value is: org.doxygen.Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
+# The default value is: Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_NAME = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
+# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
+# Windows.
+#
+# The HTML Help Workshop contains a compiler that can convert all HTML output
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
+# files are now used as the Windows 98 help format, and will replace the old
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
+# HTML files also contain an index, a table of contents, and you can search for
+# words in the documentation. The HTML workshop also contains a viewer for
+# compressed HTML files.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_HTMLHELP = NO
+
+# The CHM_FILE tag can be used to specify the file name of the resulting .chm
+# file. You can add a path in front of the file if the result should not be
+# written to the html output directory.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_FILE =
+
+# The HHC_LOCATION tag can be used to specify the location (absolute path
+# including file name) of the HTML help compiler (hhc.exe). If non-empty,
+# doxygen will try to run the HTML help compiler on the generated index.hhp.
+# The file has to be specified with full path.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+HHC_LOCATION =
+
+# The GENERATE_CHI flag controls if a separate .chi index file is generated
+# (YES) or that it should be included in the master .chm file (NO).
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+GENERATE_CHI = NO
+
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
+# and project file content.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_INDEX_ENCODING =
+
+# The BINARY_TOC flag controls whether a binary table of contents is generated
+# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
+# enables the Previous and Next buttons.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members to
+# the table of contents of the HTML help documentation and to the tree view.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+TOC_EXPAND = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
+# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
+# (.qch) of the generated HTML documentation.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
+# the file name of the resulting .qch file. The path specified is relative to
+# the HTML output folder.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
+# Project output. For more information please see Qt Help Project / Namespace
+# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_NAMESPACE = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
+# Help Project output. For more information please see Qt Help Project / Virtual
+# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
+# folders).
+# The default value is: doc.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
+# filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_NAME =
+
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's filter section matches. Qt Help Project / Filter Attributes (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_SECT_FILTER_ATTRS =
+
+# The QHG_LOCATION tag can be used to specify the location of Qt's
+# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
+# generated .qhp file.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHG_LOCATION =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
+# generated, together with the HTML files, they form an Eclipse help plugin. To
+# install this plugin and make it available under the help contents menu in
+# Eclipse, the contents of the directory containing the HTML and XML files needs
+# to be copied into the plugins directory of eclipse. The name of the directory
+# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
+# After copying Eclipse needs to be restarted before the help appears.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_ECLIPSEHELP = NO
+
+# A unique identifier for the Eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have this
+# name. Each documentation set should have its own identifier.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
+
+ECLIPSE_DOC_ID = org.doxygen.Project
+
+# If you want full control over the layout of the generated HTML pages it might
+# be necessary to disable the index and replace it with your own. The
+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
+# of each HTML page. A value of NO enables the index and the value YES disables
+# it. Since the tabs in the index contain the same information as the navigation
+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+DISABLE_INDEX = NO
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information. If the tag
+# value is set to YES, a side panel will be generated containing a tree-like
+# index structure (just like the one that is generated for HTML Help). For this
+# to work a browser that supports JavaScript, DHTML, CSS and frames is required
+# (i.e. any modern browser). Windows users are probably better off using the
+# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
+# further fine-tune the look of the index. As an example, the default style
+# sheet generated by doxygen has an example that shows how to put an image at
+# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
+# the same information as the tab index, you could consider setting
+# DISABLE_INDEX to YES when enabling this option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_TREEVIEW = NO
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
+# doxygen will group on one line in the generated HTML documentation.
+#
+# Note that a value of 0 will completely suppress the enum values from appearing
+# in the overview section.
+# Minimum value: 0, maximum value: 20, default value: 4.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+ENUM_VALUES_PER_LINE = 4
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
+# to set the initial width (in pixels) of the frame in which the tree is shown.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+TREEVIEW_WIDTH = 250
+
+# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
+# external symbols imported via tag files in a separate window.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+EXT_LINKS_IN_WINDOW = NO
+
+# Use this tag to change the font size of LaTeX formulas included as images in
+# the HTML documentation. When you change the font size after a successful
+# doxygen run you need to manually remove any form_*.png images from the HTML
+# output directory to force them to be regenerated.
+# Minimum value: 8, maximum value: 50, default value: 10.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_FONTSIZE = 10
+
+# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are not
+# supported properly for IE 6.0, but are supported on all modern browsers.
+#
+# Note that when changing this option you need to delete any form_*.png files in
+# the HTML output directory before the changes have effect.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_TRANSPARENT = YES
+
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
+# https://www.mathjax.org) which uses client side Javascript for the rendering
+# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
+# installed or if you want to formulas look prettier in the HTML output. When
+# enabled you may also need to install MathJax separately and configure the path
+# to it using the MATHJAX_RELPATH option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+USE_MATHJAX = NO
+
+# When MathJax is enabled you can set the default output format to be used for
+# the MathJax output. See the MathJax site (see:
+# http://docs.mathjax.org/en/latest/output.html) for more details.
+# Possible values are: HTML-CSS (which is slower, but has the best
+# compatibility), NativeMML (i.e. MathML) and SVG.
+# The default value is: HTML-CSS.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_FORMAT = HTML-CSS
+
+# When MathJax is enabled you need to specify the location relative to the HTML
+# output directory using the MATHJAX_RELPATH option. The destination directory
+# should contain the MathJax.js script. For instance, if the mathjax directory
+# is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
+# Content Delivery Network so you can quickly see the result without installing
+# MathJax. However, it is strongly recommended to install a local copy of
+# MathJax from https://www.mathjax.org before deployment.
+# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
+# extension names that should be enabled during MathJax rendering. For example
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_EXTENSIONS =
+
+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
+# of code that will be used on startup of the MathJax code. See the MathJax site
+# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
+# example see the documentation.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_CODEFILE =
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
+# the HTML output. The underlying search engine uses javascript and DHTML and
+# should work on any modern browser. Note that when using HTML help
+# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
+# there is already a search function so this one should typically be disabled.
+# For large projects the javascript based search engine can be slow, then
+# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
+# search using the keyboard; to jump to the search box use + S
+# (what the is depends on the OS and browser, but it is typically
+# , /, or both). Inside the search box use the to jump into the search results window, the results can be navigated
+# using the . Press to select an item or to cancel
+# the search. The filter options can be selected when the cursor is inside the
+# search box by pressing +. Also here use the
+# to select a filter and or to activate or cancel the filter
+# option.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+SEARCHENGINE = YES
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a web server instead of a web client using Javascript. There
+# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
+# setting. When disabled, doxygen will generate a PHP script for searching and
+# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
+# and searching needs to be provided by external tools. See the section
+# "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SERVER_BASED_SEARCH = NO
+
+# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
+# script for searching. Instead the search results are written to an XML file
+# which needs to be processed by an external indexer. Doxygen will invoke an
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
+# search results.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: https://xapian.org/).
+#
+# See the section "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH = NO
+
+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
+# which will return the search results when EXTERNAL_SEARCH is enabled.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: https://xapian.org/). See the section "External Indexing and
+# Searching" for details.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHENGINE_URL =
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+# The default file is: searchdata.xml.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHDATA_FILE = searchdata.xml
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
+# projects and redirect the results back to the right project.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH_ID =
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+# projects other than the one defined by this configuration file, but that are
+# all added to the same external search index. Each project needs to have a
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
+# to a relative location where the documentation can be found. The format is:
+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTRA_SEARCH_MAPPINGS =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
+# The default value is: YES.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked.
+#
+# Note that when not enabling USE_PDFLATEX the default is latex when enabling
+# USE_PDFLATEX the default is pdflatex and when in the later case latex is
+# chosen this is overwritten by pdflatex. For specific output languages the
+# default can have been set differently, this depends on the implementation of
+# the output language.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_CMD_NAME =
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
+# index for LaTeX.
+# Note: This tag is used in the Makefile / make.bat.
+# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
+# (.tex).
+# The default file is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
+# generate index for LaTeX. In case there is no backslash (\) as first character
+# it will be automatically added in the LaTeX code.
+# Note: This tag is used in the generated output file (.tex).
+# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
+# The default value is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_MAKEINDEX_CMD = makeindex
+
+# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used by the
+# printer.
+# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
+# 14 inches) and executive (7.25 x 10.5 inches).
+# The default value is: a4.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PAPER_TYPE = a4
+
+# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
+# that should be included in the LaTeX output. The package can be specified just
+# by its name or with the correct syntax as to be used with the LaTeX
+# \usepackage command. To get the times font for instance you can specify :
+# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
+# To use the option intlimits with the amsmath package you can specify:
+# EXTRA_PACKAGES=[intlimits]{amsmath}
+# If left blank no extra packages will be included.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
+# generated LaTeX document. The header should contain everything until the first
+# chapter. If it is left blank doxygen will generate a standard header. See
+# section "Doxygen usage" for information on how to let doxygen write the
+# default header to a separate file.
+#
+# Note: Only use a user-defined header if you know what you are doing! The
+# following commands have a special meaning inside the header: $title,
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
+# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
+# string, for the replacement values of the other commands the user is referred
+# to HTML_HEADER.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HEADER =
+
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
+# generated LaTeX document. The footer should contain everything after the last
+# chapter. If it is left blank doxygen will generate a standard footer. See
+# LATEX_HEADER for more information on how to generate a default footer and what
+# special commands can be used inside the footer.
+#
+# Note: Only use a user-defined footer if you know what you are doing!
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_FOOTER =
+
+# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# LaTeX style sheets that are included after the standard style sheets created
+# by doxygen. Using this option one can overrule certain style aspects. Doxygen
+# will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list).
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_STYLESHEET =
+
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the LATEX_OUTPUT output
+# directory. Note that the files will be copied as-is; there are no commands or
+# markers available.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_FILES =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
+# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
+# contain links (just like the HTML output) instead of page references. This
+# makes the output suitable for online browsing using a PDF viewer.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PDF_HYPERLINKS = YES
+
+# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
+# the PDF file directly from the LaTeX files. Set this option to YES, to get a
+# higher quality PDF documentation.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+USE_PDFLATEX = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
+# command to the generated LaTeX files. This will instruct LaTeX to keep running
+# if errors occur, instead of asking the user for help. This option is also used
+# when generating formulas in HTML.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BATCHMODE = NO
+
+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
+# index chapters (such as File Index, Compound Index, etc.) in the output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HIDE_INDICES = NO
+
+# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
+# code with syntax highlighting in the LaTeX output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_SOURCE_CODE = NO
+
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. See
+# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
+# The default value is: plain.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BIB_STYLE = plain
+
+# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
+# page will contain the date and time when the page was generated. Setting this
+# to NO can help when comparing the output of multiple runs.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_TIMESTAMP = NO
+
+# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
+# path from which the emoji images will be read. If a relative path is entered,
+# it will be relative to the LATEX_OUTPUT directory. If left blank the
+# LATEX_OUTPUT directory will be used.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EMOJI_DIRECTORY =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
+# RTF output is optimized for Word 97 and may not look too pretty with other RTF
+# readers/editors.
+# The default value is: NO.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: rtf.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
+# contain hyperlink fields. The RTF file will contain links (just like the HTML
+# output) instead of page references. This makes the output suitable for online
+# browsing using Word or some other Word compatible readers that support those
+# fields.
+#
+# Note: WordPad (write) and others do not support links.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# configuration file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+#
+# See also section "Doxygen usage" for information on how to generate the
+# default style sheet that doxygen normally uses.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an RTF document. Syntax is
+# similar to doxygen's configuration file. A template extensions file can be
+# generated using doxygen -e rtf extensionFile.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_EXTENSIONS_FILE =
+
+# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
+# with syntax highlighting in the RTF output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_SOURCE_CODE = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
+# classes and files.
+# The default value is: NO.
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it. A directory man3 will be created inside the directory specified by
+# MAN_OUTPUT.
+# The default directory is: man.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to the generated
+# man pages. In case the manual section does not start with a number, the number
+# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
+# optional.
+# The default value is: .3.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_EXTENSION = .3
+
+# The MAN_SUBDIR tag determines the name of the directory created within
+# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
+# MAN_EXTENSION with the initial . removed.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_SUBDIR =
+
+# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
+# will generate one additional man file for each entity documented in the real
+# man page(s). These additional files only source the real man page, but without
+# them the man command would be unable to find the correct page.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
+# captures the structure of the code including all documentation.
+# The default value is: NO.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_OUTPUT = xml
+
+# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
+# listings (including syntax highlighting and cross-referencing information) to
+# the XML output. Note that enabling this will significantly increase the size
+# of the XML output.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_PROGRAMLISTING = YES
+
+# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
+# namespace members in file scope as well, matching the HTML output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_NS_MEMB_FILE_SCOPE = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
+# that can be used to generate PDF.
+# The default value is: NO.
+
+GENERATE_DOCBOOK = NO
+
+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
+# front of it.
+# The default directory is: docbook.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_OUTPUT = docbook
+
+# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
+# program listings (including syntax highlighting and cross-referencing
+# information) to the DOCBOOK output. Note that enabling this will significantly
+# increase the size of the DOCBOOK output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_PROGRAMLISTING = NO
+
+#---------------------------------------------------------------------------
+# Configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
+# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
+# the structure of the code including all documentation. Note that this feature
+# is still experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
+# file that captures the structure of the code including all documentation.
+#
+# Note that this feature is still experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
+# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
+# output from the Perl module output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
+# formatted so it can be parsed by a human reader. This is useful if you want to
+# understand what is going on. On the other hand, if this tag is set to NO, the
+# size of the Perl module output will be much smaller and Perl will parse it
+# just the same.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file are
+# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
+# so different doxyrules.make files included by the same Makefile don't
+# overwrite each other's variables.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
+# C-preprocessor directives found in the sources and include files.
+# The default value is: YES.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
+# in the source code. If set to NO, only conditional compilation will be
+# performed. Macro expansion can be done in a controlled way by setting
+# EXPAND_ONLY_PREDEF to YES.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
+# the macro expansion is limited to the macros specified with the PREDEFINED and
+# EXPAND_AS_DEFINED tags.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES, the include files in the
+# INCLUDE_PATH will be searched if a #include is found.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by the
+# preprocessor.
+# This tag requires that the tag SEARCH_INCLUDES is set to YES.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will be
+# used.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that are
+# defined before the preprocessor is started (similar to the -D option of e.g.
+# gcc). The argument of the tag is a list of macros of the form: name or
+# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
+# is assumed. To prevent a macro definition from being undefined via #undef or
+# recursively expanded use the := operator instead of the = operator.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+PREDEFINED =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
+# tag can be used to specify a list of macro names that should be expanded. The
+# macro definition that is found in the sources will be used. Use the PREDEFINED
+# tag if you want to use a different macro definition that overrules the
+# definition found in the source code.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
+# remove all references to function-like macros that are alone on a line, have
+# an all uppercase name, and do not end with a semicolon. Such function macros
+# are typically used for boiler-plate code, and will confuse the parser if not
+# removed.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES tag can be used to specify one or more tag files. For each tag
+# file the location of the external documentation should be added. The format of
+# a tag file without this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where loc1 and loc2 can be relative or absolute paths or URLs. See the
+# section "Linking to external documentation" for more information about the use
+# of tag files.
+# Note: Each tag file must have a unique name (where the name does NOT include
+# the path). If a tag file is not located in the directory in which doxygen is
+# run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
+# tag file that is based on the input files it reads. See section "Linking to
+# external documentation" for more information about the usage of tag files.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
+# the class index. If set to NO, only the inherited external classes will be
+# listed.
+# The default value is: NO.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will be
+# listed.
+# The default value is: YES.
+
+EXTERNAL_GROUPS = YES
+
+# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
+# the related pages index. If set to NO, only the current project's pages will
+# be listed.
+# The default value is: YES.
+
+EXTERNAL_PAGES = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
+# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
+# NO turns the diagrams off. Note that this option also works with HAVE_DOT
+# disabled, but it is recommended to install and use dot, since it yields more
+# powerful graphs.
+# The default value is: YES.
+
+CLASS_DIAGRAMS = YES
+
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
+# then run dia to produce the diagram and insert it in the documentation. The
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
+# If left empty dia is assumed to be found in the default search path.
+
+DIA_PATH =
+
+# If set to YES the inheritance and collaboration graphs will hide inheritance
+# and usage relations if the target is undocumented or is not a class.
+# The default value is: YES.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz (see:
+# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
+# Bell Labs. The other options in this section have no effect if this option is
+# set to NO
+# The default value is: NO.
+
+HAVE_DOT = NO
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
+# to run in parallel. When set to 0 doxygen will base this on the number of
+# processors available in the system. You can set it explicitly to a value
+# larger than 0 to get control over the balance between CPU load and processing
+# speed.
+# Minimum value: 0, maximum value: 32, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_NUM_THREADS = 0
+
+# When you want a differently looking font in the dot files that doxygen
+# generates you can specify the font name using DOT_FONTNAME. You need to make
+# sure dot is able to find the font, which can be done by putting it in a
+# standard location or by setting the DOTFONTPATH environment variable or by
+# setting DOT_FONTPATH to the directory containing the font.
+# The default value is: Helvetica.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTNAME = Helvetica
+
+# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
+# dot graphs.
+# Minimum value: 4, maximum value: 24, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTSIZE = 10
+
+# By default doxygen will tell dot to use the default font as specified with
+# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
+# the path where dot can find it using this tag.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
+# each documented class showing the direct and indirect inheritance relations.
+# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
+# graph for each documented class showing the direct and indirect implementation
+# dependencies (inheritance, containment, and class references variables) of the
+# class with other documented classes.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
+# groups, showing the direct groups dependencies.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LOOK = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
+# class node. If there are many fields or methods and many nodes the graph may
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
+# number of items for each type to make the size more manageable. Set this to 0
+# for no limit. Note that the threshold may be exceeded by 50% before the limit
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
+# but if the number exceeds 15, the total amount of fields shown is limited to
+# 10.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LIMIT_NUM_FIELDS = 10
+
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
+# collaboration graphs will show the relations between templates and their
+# instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+TEMPLATE_RELATIONS = NO
+
+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
+# YES then doxygen will generate a graph for each documented file showing the
+# direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDE_GRAPH = YES
+
+# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
+# set to YES then doxygen will generate a graph for each documented file showing
+# the direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable call graphs for selected
+# functions only using the \callgraph command. Disabling a call graph can be
+# accomplished by means of the command \hidecallgraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALL_GRAPH = NO
+
+# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable caller graphs for selected
+# functions only using the \callergraph command. Disabling a caller graph can be
+# accomplished by means of the command \hidecallergraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALLER_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
+# hierarchy of all classes instead of a textual one.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
+# dependencies a directory has on other directories in a graphical way. The
+# dependency relations are determined by the #include relations between the
+# files in the directories.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DIRECTORY_GRAPH = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. For an explanation of the image formats see the section
+# output formats in the documentation of the dot tool (Graphviz (see:
+# http://www.graphviz.org/)).
+# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
+# to make the SVG files visible in IE 9+ (other browsers do not have this
+# requirement).
+# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
+# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
+# png:gdiplus:gdiplus.
+# The default value is: png.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_IMAGE_FORMAT = png
+
+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
+# enable generation of interactive SVG images that allow zooming and panning.
+#
+# Note that this requires a modern browser other than Internet Explorer. Tested
+# and working are Firefox, Chrome, Safari, and Opera.
+# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
+# the SVG files visible. Older versions of IE do not have SVG support.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INTERACTIVE_SVG = NO
+
+# The DOT_PATH tag can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the \dotfile
+# command).
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOTFILE_DIRS =
+
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
+# contain msc files that are included in the documentation (see the \mscfile
+# command).
+
+MSCFILE_DIRS =
+
+# The DIAFILE_DIRS tag can be used to specify one or more directories that
+# contain dia files that are included in the documentation (see the \diafile
+# command).
+
+DIAFILE_DIRS =
+
+# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
+# path where java can find the plantuml.jar file. If left blank, it is assumed
+# PlantUML is not used or called during a preprocessing step. Doxygen will
+# generate a warning when it encounters a \startuml command in this case and
+# will not generate output for the diagram.
+
+PLANTUML_JAR_PATH =
+
+# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
+# configuration file for plantuml.
+
+PLANTUML_CFG_FILE =
+
+# When using plantuml, the specified paths are searched for files specified by
+# the !include statement in a plantuml block.
+
+PLANTUML_INCLUDE_PATH =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
+# that will be shown in the graph. If the number of nodes in a graph becomes
+# larger than this value, doxygen will truncate the graph, which is visualized
+# by representing a node as a red box. Note that doxygen if the number of direct
+# children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
+# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+# Minimum value: 0, maximum value: 10000, default value: 50.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_GRAPH_MAX_NODES = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
+# generated by dot. A depth value of 3 means that only nodes reachable from the
+# root by following a path via at most 3 edges will be shown. Nodes that lay
+# further from the root node will be omitted. Note that setting this option to 1
+# or 2 may greatly reduce the computation time needed for large code bases. Also
+# note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+# Minimum value: 0, maximum value: 1000, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+MAX_DOT_GRAPH_DEPTH = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not seem
+# to support this out of the box.
+#
+# Warning: Depending on the platform used, enabling this option may lead to
+# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
+# read).
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_TRANSPARENT = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10) support
+# this, this feature is disabled by default.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
+# explaining the meaning of the various boxes and arrows in the dot generated
+# graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
+# files that are used to generate the various graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_CLEANUP = YES