Skip to content

Commit df84eec

Browse files
committed
Enable doxygen for source files
Turn on doxygen for .c and .cpp files. Ignore the source directories in frameworks, as several of these files contain doxygen errors.
1 parent 4556a3e commit df84eec

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

doxyfile_options

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -805,7 +805,7 @@ INPUT_ENCODING = UTF-8
805805
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
806806
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
807807

808-
FILE_PATTERNS = *.h
808+
FILE_PATTERNS = *.h *.c *.cpp
809809

810810
# The RECURSIVE tag can be used to specify whether or not subdirectories should
811811
# be searched for input files as well.
@@ -847,6 +847,7 @@ EXCLUDE_PATTERNS = */tools/* \
847847
*/features/storage/* \
848848
*/features/unsupported/* \
849849
*/features/filesystem/* \
850+
*/features/frameworks/*/source/* \
850851

851852
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
852853
# (namespaces, classes, functions, etc.) that should be excluded from the

doxygen_options.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@
88
"PREDEFINED": "DOXYGEN_ONLY DEVICE_ANALOGIN DEVICE_ANALOGOUT DEVICE_CAN DEVICE_ETHERNET DEVICE_EMAC DEVICE_FLASH DEVICE_I2C DEVICE_I2CSLAVE DEVICE_I2C_ASYNCH DEVICE_INTERRUPTIN DEVICE_LOWPOWERTIMER DEVICE_PORTIN DEVICE_PORTINOUT DEVICE_PORTOUT DEVICE_PWMOUT DEVICE_RTC DEVICE_TRNG DEVICE_SERIAL DEVICE_SERIAL_ASYNCH DEVICE_SERIAL_FC DEVICE_SLEEP DEVICE_SPI DEVICE_SPI_ASYNCH DEVICE_SPISLAVE DEVICE_STORAGE \"MBED_DEPRECATED_SINCE(f, g)=\" \"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=\"",
99
"EXPAND_AS_DEFINED": "",
1010
"SKIP_FUNCTION_MACROS": "NO",
11-
"EXCLUDE_PATTERNS": "*/tools/* */TESTS/* */targets/* */FEATURE_*/* */features/mbedtls/* */features/storage/* */features/unsupported/* */features/filesystem/* */BUILD/* */rtos/TARGET_CORTEX/rtx*/* */cmsis/* */features/FEATURES_*"
11+
"FILE_PATTERNS": "*.h *.c *.cpp",
12+
"EXCLUDE_PATTERNS": "*/tools/* */TESTS/* */targets/* */FEATURE_*/* */features/mbedtls/* */features/storage/* */features/unsupported/* */features/filesystem/* */BUILD/* */rtos/TARGET_CORTEX/rtx*/* */cmsis/* */features/FEATURES_* */features/frameworks/*/source/*"
1213
}

0 commit comments

Comments
 (0)