123f0549e0
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>
39 lines
953 B
Awk
Executable file
39 lines
953 B
Awk
Executable file
#!/usr/bin/awk -f
|
|
|
|
# libmaple's own Evil Mangler
|
|
#
|
|
# Input filter hack to trick Doxygen into thinking that a series
|
|
# header is in a separate namespace. This is necessary because Doxygen
|
|
# doesn't know how to cope with two data structures with the same name
|
|
# in different places in the project. (We do that all the time,
|
|
# e.g. for foo_reg_map structs.)
|
|
#
|
|
# E.g., an STM32F1 header gets transformed into:
|
|
#
|
|
# namespace stm32f1 {
|
|
# <contents of header>
|
|
# }
|
|
|
|
BEGIN {
|
|
# For extracting series component from header FILENAME.
|
|
series_regex = "/stm32[flw][0-9]*/";
|
|
# Holds header FILENAME. Cargo-culted; not sure why it's necessary.
|
|
f = "";
|
|
# Holds series component.
|
|
series = "";
|
|
}
|
|
{
|
|
if (f != FILENAME) {
|
|
f = FILENAME;
|
|
match(f, series_regex);
|
|
series = substr(f, RSTART + 1, RLENGTH - 2);
|
|
printf("namespace %s {\n", series);
|
|
}
|
|
print;
|
|
}
|
|
END {
|
|
if (series != "") {
|
|
print "}"
|
|
}
|
|
}
|