# Doxygen configuration for STM32_TSC2046 (standalone library repo).
# Run 'doxygen' in this folder; HTML is written to docs/ (not committed).

PROJECT_NAME           = "STM32_TSC2046"
PROJECT_BRIEF          = "STM32 HAL C++ driver for the TI TSC2046 resistive touchscreen controller (Adafruit 5767)"
OUTPUT_DIRECTORY       = docs

INPUT                  = README.md TSC2046.hpp TSC2046.cpp
FILE_PATTERNS          = *.hpp *.cpp *.md
RECURSIVE              = NO

# The README is the landing page.
USE_MDFILE_AS_MAINPAGE = README.md

# This library has genuine C++ classes, so do NOT flatten them to C-style output.
EXTRACT_ALL            = NO
EXTRACT_STATIC         = YES
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO
WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR      = YES
WARN_NO_PARAMDOC       = YES

GENERATE_HTML          = YES
GENERATE_LATEX         = NO
FULL_PATH_NAMES        = NO
STRIP_FROM_PATH        = .
QUIET                  = NO

# Reader navigation and clickable source.
GENERATE_TREEVIEW      = YES
SOURCE_BROWSER         = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES

# Optional call / caller graphs (requires Graphviz 'dot'):
# HAVE_DOT             = YES
# CALL_GRAPH           = YES
# CALLER_GRAPH         = YES
