RIOT-OS / RIOT

RIOT - The friendly OS for IoT
https://riot-os.org
GNU Lesser General Public License v2.1
4.85k stars 1.97k forks source link

Unignore boards peripheral configuration in Doxygen #2209

Closed LudwigKnuepfer closed 7 years ago

LudwigKnuepfer commented 9 years ago

Is there any particular reason to ignore all the periph_conf.h files?

With:

diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile
index d2a396d..a657994 100644
--- a/doc/doxygen/riot.doxyfile
+++ b/doc/doxygen/riot.doxyfile
@@ -822,7 +822,6 @@ EXCLUDE_PATTERNS       = */board/*/tools/* \
                          */drivers/nrf24l01p/include/nrf24l01p_settings.h \
                          */cpu/nrf51822/include/nrf51.h \
                          */cpu/lpc1768/include/LPC17xx.h \
-                         */boards/*/include/periph_conf.h \
                          */cpu/x86/include/x86_pci.h \
                          */cpu/sam3x8e/include/sam3x8e.h \

I only got warnings in 4 files.

$ make doc >doclog 2>&1
$ grep warning doclog | grep periph | wc -l
398
$ grep warning doclog | grep periph | sed -e 's/.*\(boards\/.*\.h\):.*/\1/' | sort | uniq
boards/arduino-mega2560/include/periph_conf.h
boards/fox/include/periph_conf.h
boards/iot-lab_M3/include/periph_conf.h
boards/spark-core/include/periph_conf.h
OlegHahm commented 9 years ago

Wouldn't it make more sense to document periph.conf at a central point instead of documenting each instance?

LudwigKnuepfer commented 9 years ago

No, because it specifies what is enabled per board.

OlegHahm commented 9 years ago

I see.

haukepetersen commented 9 years ago

agree with @LudwigOrtmann, I think the periph_conf files should be part of the doxygen documentation.

PeterKietzmann commented 9 years ago

So you agree to discard the periph_conf from the EXCLUDE_PATTERNS?

haukepetersen commented 9 years ago

yes