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-08-05 18:44:17 +00:00
|
|
|
# project metadata
|
2024-06-25 14:57:54 +00:00
|
|
|
DOCSET_BUNDLE_ID = dev.lizardbyte.Sunshine
|
|
|
|
|
DOCSET_PUBLISHER_ID = dev.lizardbyte.Sunshine.documentation
|
2024-06-26 14:44:32 +00:00
|
|
|
PROJECT_BRIEF = "Self-hosted game stream host for Moonlight."
|
2024-06-25 14:57:54 +00:00
|
|
|
PROJECT_ICON = ../sunshine.ico
|
|
|
|
|
PROJECT_LOGO = ../sunshine.png
|
|
|
|
|
PROJECT_NAME = Sunshine
|
2024-08-05 18:44:17 +00:00
|
|
|
|
|
|
|
|
# project specific settings
|
|
|
|
|
DOT_GRAPH_MAX_NODES = 60
|
|
|
|
|
IMAGE_PATH = ../docs/images
|
2024-10-30 14:06:06 +00:00
|
|
|
INCLUDE_PATH = ../third-party/build-deps/dist/Linux-x86_64/include/
|
2024-08-05 18:44:17 +00:00
|
|
|
PREDEFINED += SUNSHINE_BUILD_WAYLAND
|
|
|
|
|
PREDEFINED += SUNSHINE_TRAY=1
|
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-08-05 18:44:17 +00:00
|
|
|
# files and directories to process
|
|
|
|
|
USE_MDFILE_AS_MAINPAGE = ../README.md
|
|
|
|
|
INPUT = ../README.md \
|
|
|
|
|
getting_started.md \
|
|
|
|
|
changelog.md \
|
|
|
|
|
../DOCKER_README.md \
|
|
|
|
|
third_party_packages.md \
|
|
|
|
|
gamestream_migration.md \
|
|
|
|
|
legal.md \
|
|
|
|
|
configuration.md \
|
|
|
|
|
app_examples.md \
|
|
|
|
|
guides.md \
|
|
|
|
|
performance_tuning.md \
|
2024-10-30 20:34:18 +00:00
|
|
|
api.md \
|
2024-08-05 18:44:17 +00:00
|
|
|
troubleshooting.md \
|
|
|
|
|
building.md \
|
|
|
|
|
contributing.md \
|
|
|
|
|
../third-party/doxyconfig/docs/source_code.md \
|
|
|
|
|
../src
|
2024-09-11 21:56:54 +00:00
|
|
|
|
|
|
|
|
# extra css
|
|
|
|
|
HTML_EXTRA_STYLESHEET += doc-styles.css
|
|
|
|
|
|
|
|
|
|
# extra js
|
|
|
|
|
HTML_EXTRA_FILES += configuration.js
|
