cfe-common.doxyfile.in

#---------------------------------------------------------------------------
# CFE common setup for including in stand alone or mission documentation
#---------------------------------------------------------------------------

PREDEFINED            += @CFEDOC_PREDEFINED@

ALIASES               += "cfeescfg=\xrefitem cfeescfg \"Purpose\" \"cFE Executive Services Configuration Parameters\" " \
                         "cfeevscfg=\xrefitem cfeevscfg \"Purpose\" \"cFE Event Services Configuration Parameters\" " \
                         "cfetblcfg=\xrefitem cfetblcfg \"Purpose\" \"cFE Table Services Configuration Parameters\" " \
                         "cfetimecfg=\xrefitem cfetimecfg \"Purpose\" \"cFE Time Services Configuration Parameters\" " \
                         "cfesbcfg=\xrefitem cfesbcfg \"Purpose\" \"cFE Software Bus Configuration Parameters\" " \
                         "cfemissioncfg=\xrefitem cfemissioncfg \"Purpose\" \"cFE Mission Configuration Parameters\" " \
                         "cfeplatformcfg=\xrefitem cfeplatformcfg \"Purpose\" \"cFE Platform Configuration Parameters\" " \
                         "cfeescmd=\xrefitem cfeescmds \"Name\" \"cFE Executive Services Commands\" " \
                         "cfeevscmd=\xrefitem cfeevscmds \"Name\" \"cFE Event Services Commands\" " \
                         "cfesbcmd=\xrefitem cfesbcmds \"Name\" \"cFE Software Bus Commands\" " \
                         "cfetimecmd=\xrefitem cfetimecmds \"Name\" \"cFE Time Services Commands\" " \
                         "cfetblcmd=\xrefitem cfetblcmds \"Name\" \"cFE Table Services Commands\" " \
                         "cfetbltlm=\xrefitem cfetbltlm \"Name\" \"cFE Table Services Telemetry\" " \
                         "cfeestlm=\xrefitem cfeestlm \"Name\" \"cFE Executive Services Telemetry\" " \
                         "cfeevstlm=\xrefitem cfeevstlm \"Name\" \"cFE Event Services Telemetry\" " \
                         "cfesbtlm=\xrefitem cfesbtlm \"Name\" \"cFE Software Bus Telemetry\" " \
                         "cfetimetlm=\xrefitem cfetimetlm \"Name\" \"cFE Time Services Telemetry\" " \
                         "cfecmdmnemonic=\xrefitem cfecmdmnems \"Command Mnemonic(s)\" \"cFE Command Mnemonic Cross Reference\" " \
                         "cfetlmmnemonic=\xrefitem cfetlmmnems \"Telemetry Mnemonic(s)\" \"cFE Telemetry Mnemonic Cross Reference\" "

# Always include a standard set of CFE documentation in the input set
IMAGE_PATH            += @MISSION_SOURCE_DIR@/cfe/docs/src

# Front documentation material
INPUT                 += @MISSION_SOURCE_DIR@/cfe/docs/src/cfe_frontpage.dox
INPUT                 += @MISSION_SOURCE_DIR@/cfe/docs/src/cfe_glossary.dox
INPUT                 += @MISSION_SOURCE_DIR@/cfe/docs/src/cfs_versions.dox
INPUT                 += @MISSION_SOURCE_DIR@/cfe/docs/src/cfe_api.dox
INPUT                 += @MISSION_SOURCE_DIR@/cfe/docs/src/cfe_es.dox
INPUT                 += @MISSION_SOURCE_DIR@/cfe/docs/src/cfe_evs.dox
INPUT                 += @MISSION_SOURCE_DIR@/cfe/docs/src/cfe_sb.dox
INPUT                 += @MISSION_SOURCE_DIR@/cfe/docs/src/cfe_tbl.dox
INPUT                 += @MISSION_SOURCE_DIR@/cfe/docs/src/cfe_time.dox
INPUT                 += @MISSION_SOURCE_DIR@/cfe/docs/src/cfe_xref.dox

# Public headers
INPUT                 += @MISSION_USERGUIDE_HEADERFILES@

# Strip mission from path
STRIP_FROM_PATH       += @MISSION_SOURCE_DIR@

# CFE mnemonic mappings
@INCLUDE = @MISSION_SOURCE_DIR@/cfe/docs/src/mnem_maps/cfe_es_cmd_mnem_map
@INCLUDE = @MISSION_SOURCE_DIR@/cfe/docs/src/mnem_maps/cfe_es_tlm_mnem_map
@INCLUDE = @MISSION_SOURCE_DIR@/cfe/docs/src/mnem_maps/cfe_tbl_cmd_mnem_map
@INCLUDE = @MISSION_SOURCE_DIR@/cfe/docs/src/mnem_maps/cfe_tbl_tlm_mnem_map
@INCLUDE = @MISSION_SOURCE_DIR@/cfe/docs/src/mnem_maps/cfe_time_cmd_mnem_map
@INCLUDE = @MISSION_SOURCE_DIR@/cfe/docs/src/mnem_maps/cfe_time_tlm_mnem_map
@INCLUDE = @MISSION_SOURCE_DIR@/cfe/docs/src/mnem_maps/cfe_evs_cmd_mnem_map
@INCLUDE = @MISSION_SOURCE_DIR@/cfe/docs/src/mnem_maps/cfe_evs_tlm_mnem_map
@INCLUDE = @MISSION_SOURCE_DIR@/cfe/docs/src/mnem_maps/cfe_sb_cmd_mnem_map
@INCLUDE = @MISSION_SOURCE_DIR@/cfe/docs/src/mnem_maps/cfe_sb_tlm_mnem_map

# Exclude repo documentation
EXCLUDE_PATTERNS       += "*/CHANGELOG.md"
EXCLUDE_PATTERNS       += "*/CODE_OF_CONDUCT.md"
EXCLUDE_PATTERNS       += "*/CONTRIBUTING.md"
EXCLUDE_PATTERNS       += "*/README.md"
EXCLUDE_PATTERNS       += "*/SECURITY.md"