Doxyfile

# Doxyfile 1.9.7

# 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 (\" \").
#
# Note:
#
# Use doxygen to compare the used configuration file with the template
# configuration file:
# doxygen -x [configFile]
# Use doxygen to compare the used configuration file with the template
# configuration file without replacing the environment variables or CMake type
# replacement variables:
# doxygen -x_noenv [configFile]

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------

DOXYFILE_ENCODING      = UTF-8
PROJECT_NAME           = "TLOModel - Profiling"
PROJECT_BRIEF          = "Autorendering profiling outputs from the TLOModel"
PROJECT_LOGO           = # Blank == No logo
OUTPUT_DIRECTORY       = # Blank == write html/ folder to current directory
OUTPUT_LANGUAGE        = English

# By default Python docstrings are displayed as preformatted text and doxygen's
# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
# doxygen's special commands can be used and the contents of the docstring
# documentation blocks is shown as doxygen documentation.
# The default value is: YES.
PYTHON_DOCSTRING       = YES

INPUT                  = website_build/
FILE_PATTERNS          = *.py
GENERATE_LATEX         = NO

STRIP_CODE_COMMENTS    = NO

# Warnings can be turned on/off if necessary
WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR      = YES

# Hijack Doxygen main page to write the developer docs
INPUT                  += src/developers.md
USE_MDFILE_AS_MAINPAGE = src/developers.md