mirror of
https://github.com/espressif/esp-matter.git
synced 2026-04-27 11:03:05 +00:00
Shu Chen
69 lines
2.2 KiB
Plaintext
69 lines
2.2 KiB
Plaintext
# This is Doxygen configuration file
|
|
#
|
|
# Doxygen provides over 260 configuration statements
|
|
# To make this file easier to follow,
|
|
# it contains only statements that are non-default
|
|
#
|
|
# NOTE:
|
|
# It is recommended not to change defaults unless specifically required
|
|
# Test any changes how they affect generated documentation
|
|
# Make sure that correct warnings are generated to flag issues with documented code
|
|
#
|
|
# For the complete list of configuration statements see:
|
|
# http://doxygen.nl/manual/config.html
|
|
|
|
|
|
PROJECT_NAME = "Programming Guide"
|
|
|
|
## The 'INPUT' statement below is used as input by script 'gen-df-input.py'
|
|
## to automatically generate API reference list files header_file.inc
|
|
## These files are placed in '_inc' directory
|
|
## and used to include in API reference documentation
|
|
|
|
INPUT = \
|
|
$(PROJECT_PATH)/components/esp_matter/esp_matter_endpoint.h \
|
|
$(PROJECT_PATH)/components/esp_matter/esp_matter_cluster.h \
|
|
$(PROJECT_PATH)/components/esp_matter/esp_matter_attribute.h \
|
|
$(PROJECT_PATH)/components/esp_matter/esp_matter_command.h \
|
|
$(PROJECT_PATH)/components/esp_matter/esp_matter_core.h \
|
|
$(PROJECT_PATH)/components/esp_matter/esp_matter_event.h \
|
|
$(PROJECT_PATH)/components/esp_matter/esp_matter_client.h \
|
|
|
|
## Get warnings for functions that have no documentation for their parameters or return value
|
|
##
|
|
WARN_NO_PARAMDOC = YES
|
|
|
|
## Enable preprocessing and remove __attribute__(...) expressions from the INPUT files
|
|
##
|
|
ENABLE_PREPROCESSING = YES
|
|
MACRO_EXPANSION = YES
|
|
EXPAND_ONLY_PREDEF = YES
|
|
PREDEFINED = \
|
|
$(ENV_DOXYGEN_DEFINES)
|
|
|
|
## Do not complain about not having dot
|
|
##
|
|
HAVE_DOT = NO
|
|
|
|
## Generate XML that is required for Breathe
|
|
##
|
|
GENERATE_XML = YES
|
|
XML_OUTPUT = xml
|
|
|
|
GENERATE_HTML = NO
|
|
HAVE_DOT = NO
|
|
GENERATE_LATEX = NO
|
|
GENERATE_MAN = YES
|
|
GENERATE_RTF = NO
|
|
|
|
## Skip distracting progress messages
|
|
##
|
|
QUIET = YES
|
|
|
|
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
|
|
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
|
|
# will automatically be disabled.
|
|
# The default value is: YES.
|
|
|
|
WARN_IF_UNDOCUMENTED = NO
|