2023-03-08 01:26:03 +00:00
|
|
|
# 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]
|
|
|
|
|
|
2024-06-25 14:57:54 +00:00
|
|
|
# must be first
|
|
|
|
|
DOXYFILE_ENCODING = UTF-8
|
2023-03-08 01:26:03 +00:00
|
|
|
|
|
|
|
|
# https://breathe.readthedocs.io/en/latest/markups.html#aliases
|
|
|
|
|
ALIASES = "rst=^^\verbatim embed:rst:leading-asterisk^^"
|
|
|
|
|
ALIASES += "endrst=\endverbatim"
|
|
|
|
|
|
2024-06-25 14:57:54 +00:00
|
|
|
DOCBOOK_OUTPUT = doxydocbook
|
|
|
|
|
DOCSET_BUNDLE_ID = dev.lizardbyte.Sunshine
|
|
|
|
|
DOCSET_PUBLISHER_ID = dev.lizardbyte.Sunshine.documentation
|
|
|
|
|
DOCSET_PUBLISHER_NAME = LizardByte
|
|
|
|
|
DOT_IMAGE_FORMAT = svg
|
2023-03-08 01:26:03 +00:00
|
|
|
|
2024-06-25 14:57:54 +00:00
|
|
|
# TODO: On Windows, Doxygen hangs when creating dot graphs if this is set to 0
|
|
|
|
|
DOT_NUM_THREADS = 1
|
2023-03-08 01:26:03 +00:00
|
|
|
|
2024-06-25 14:57:54 +00:00
|
|
|
GENERATE_HTML = YES
|
|
|
|
|
GENERATE_LATEX = NO
|
2023-03-08 01:26:03 +00:00
|
|
|
|
2024-06-25 14:57:54 +00:00
|
|
|
# TODO: Sphinx/Breathe does not support Objective-C right now, so disable XML
|
|
|
|
|
# https://github.com/breathe-doc/breathe/issues/129
|
|
|
|
|
GENERATE_XML = NO
|
2023-03-08 01:26:03 +00:00
|
|
|
|
2024-06-25 14:57:54 +00:00
|
|
|
HAVE_DOT = YES
|
|
|
|
|
HTML_COLORSTYLE = TOGGLE
|
|
|
|
|
HTML_OUTPUT = doxyhtml
|
|
|
|
|
INCLUDE_PATH = ../third-party/build-deps/ffmpeg/Linux-x86_64/include/
|
|
|
|
|
INPUT = ../src
|
|
|
|
|
INTERACTIVE_SVG = YES
|
|
|
|
|
LATEX_OUTPUT = doxylatex
|
|
|
|
|
MACRO_EXPANSION = YES
|
|
|
|
|
MAN_OUTPUT = doxyman
|
|
|
|
|
NUM_PROC_THREADS = 1
|
|
|
|
|
PREDEFINED = DOXYGEN
|
|
|
|
|
PROJECT_BRIEF = "Sunshine is a Gamestream host for Moonlight."
|
|
|
|
|
PROJECT_ICON = ../sunshine.ico
|
|
|
|
|
PROJECT_LOGO = ../sunshine.png
|
|
|
|
|
PROJECT_NAME = Sunshine
|
|
|
|
|
OUTPUT_DIRECTORY = build/doxygen
|
|
|
|
|
RECURSIVE = YES
|
|
|
|
|
RTF_OUTPUT = doxyrtf
|
|
|
|
|
SORT_BRIEF_DOCS = YES
|
|
|
|
|
STRIP_FROM_INC_PATH = ../
|
|
|
|
|
STRIP_FROM_PATH = ../
|
|
|
|
|
WARN_AS_ERROR = FAIL_ON_WARNINGS
|
2023-03-08 01:26:03 +00:00
|
|
|
|
2024-06-20 01:36:09 +00:00
|
|
|
# TODO: Enable this when we have complete documentation
|
|
|
|
|
WARN_IF_UNDOCUMENTED = NO
|
2023-03-08 01:26:03 +00:00
|
|
|
|
2024-06-25 14:57:54 +00:00
|
|
|
XML_OUTPUT = doxyxml
|
