forked from espressif/esp-iot-solution
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Doxyfile
95 lines (84 loc) · 3.95 KB
/
Doxyfile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# 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:
# https://www.stack.nl/~dimitri/doxygen/manual/config.html
PROJECT_NAME = "ESP IoT Solution Guide"
## The 'INPUT' statement below is used as input by script 'gen-df-input.py'
## to automatically generate API reference list files heder_file.inc
## These files are placed in '_inc' directory
## and used to include in API reference documentation
INPUT = \
$(PROJECT_PATH)/components/audio/dac_audio/include/dac_audio.h \
$(PROJECT_PATH)/components/audio/pwm_audio/include/pwm_audio.h \
$(PROJECT_PATH)/components/bus/include/i2c_bus.h \
$(PROJECT_PATH)/components/bus/include/i2s_lcd_driver.h \
$(PROJECT_PATH)/components/bus/include/spi_bus.h \
$(PROJECT_PATH)/components/button/include/iot_button.h \
$(PROJECT_PATH)/components/display/screen/interface_driver/scr_interface_driver.h \
$(PROJECT_PATH)/components/display/screen/screen_driver.h \
$(PROJECT_PATH)/components/display/touch_panel/touch_panel.h \
$(PROJECT_PATH)/components/knob/iot_knob.h \
$(PROJECT_PATH)/components/led/led_indicator/include/led_indicator.h \
$(PROJECT_PATH)/components/motor/esp_sensorless_bldc_control/control/include/bldc_control_param.h \
$(PROJECT_PATH)/components/motor/esp_sensorless_bldc_control/include/bldc_control.h \
$(PROJECT_PATH)/components/motor/esp_sensorless_bldc_control/user_cfg/bldc_user_cfg.h \
$(PROJECT_PATH)/components/motor/servo/include/iot_servo.h \
$(PROJECT_PATH)/components/openai/include/OpenAI.h \
$(PROJECT_PATH)/components/sensors/sensor_hub/include/hal/humiture_hal.h \
$(PROJECT_PATH)/components/sensors/sensor_hub/include/hal/imu_hal.h \
$(PROJECT_PATH)/components/sensors/sensor_hub/include/hal/light_sensor_hal.h \
$(PROJECT_PATH)/components/sensors/sensor_hub/include/iot_sensor_hub.h \
$(PROJECT_PATH)/components/sensors/sensor_hub/include/sensor_type.h \
$(PROJECT_PATH)/components/usb/usb_device_uvc/include/usb_device_uvc.h \
$(PROJECT_PATH)/components/usb/usb_stream/include/usb_stream.h \
$(PROJECT_PATH)/components/zero_detection/include/zero_detection.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 = \
__attribute__(x)= \
IRAM_ATTR= \
configSUPPORT_DYNAMIC_ALLOCATION=1 \
configSUPPORT_STATIC_ALLOCATION=1 \
configQUEUE_REGISTRY_SIZE=1 \
configUSE_RECURSIVE_MUTEXES=1 \
configTHREAD_LOCAL_STORAGE_DELETE_CALLBACKS=1 \
configNUM_THREAD_LOCAL_STORAGE_POINTERS=1 \
configUSE_APPLICATION_TASK_TAG=1 \
configTASKLIST_INCLUDE_COREID=1
## 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
## Log warnings in a file for further review
##
WARN_LOGFILE = "doxygen-warning-log.txt"
## Enable Section Tags for conditional documentation
##
ENABLED_SECTIONS += DOC_EXCLUDE_HEADER_SECTION ## To conditionally remove doc sections from IDF source files without affecting documentation in upstream files.
ENABLED_SECTIONS += DOC_SINGLE_GROUP ## To conditionally remove groups from the documentation and create a 'flat' document without affecting documentation in upstream files.