diff options
| author | Marti Bolivar <mbolivar@leaflabs.com> | 2012-05-10 15:47:56 -0400 |
|---|---|---|
| committer | Marti Bolivar <mbolivar@leaflabs.com> | 2012-05-10 15:48:48 -0400 |
| commit | 6ecabd970516bb374000f9074b5a4323da2482d5 (patch) | |
| tree | 1f4950e4a843a5bde030cd0b0f67f5a4e84cf9aa /support/doxygen/Doxyfile | |
| parent | 9ebe3545cb63a0afec3958b1ddda582d32106a4a (diff) | |
| download | librambutan-6ecabd970516bb374000f9074b5a4323da2482d5.tar.gz librambutan-6ecabd970516bb374000f9074b5a4323da2482d5.zip | |
Doxygen: add the Evil Mangler.
Whenever Doxygen is running on a series header, make it run an awk
script, the Evil Mangler, that pretends the file is enclosed in an
appropriate namespace declaration for the series target.
Doxygen chokes if two structs have the same name. This is a problem
for the series headers, which commonly have data structures with the
same name. However, if those structs are in different namespaces,
Doxygen has no problems. We obviously can't use namespaces in C
headers, so use FILTER_PATTERNS to trick Doxygen into thinking they're
there.
Ugly, but I can't think of a better way to handle this.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
Diffstat (limited to 'support/doxygen/Doxyfile')
| -rw-r--r-- | support/doxygen/Doxyfile | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/support/doxygen/Doxyfile b/support/doxygen/Doxyfile index 6dbce7d..1074403 100644 --- a/support/doxygen/Doxyfile +++ b/support/doxygen/Doxyfile @@ -690,7 +690,9 @@ INPUT_FILTER = # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. -FILTER_PATTERNS = +# Trick Doxygen into thinking series headers are in separate +# namespaces; see the Evil Mangler source for more information. +FILTER_PATTERNS = */libmaple/stm32*/include/series/*.h=./support/doxygen/evil_mangler.awk # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will be used to filter the input files when producing source |