From cdcf503adf7c6b62a4d52b7b435cc407277eeeed Mon Sep 17 00:00:00 2001 From: Gunar Schorcht Date: Thu, 17 Jan 2019 17:22:24 +0100 Subject: [PATCH 1/4] doc: remove STRIP_FROM_INC_PATH To be able to include *_params.h in docuementation, STRIP_FROM_INC_PATH has to be empty. Otherwise, a number of warnings are thrown if *_params.h files with same names exist in different directories. --- doc/doxygen/riot.doxyfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index 0e07440cd3..d2b5853831 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -161,7 +161,7 @@ STRIP_FROM_PATH = # specify the list of include paths that are normally passed to the compiler # using the -I flag. -STRIP_FROM_INC_PATH = $(STRIP_FROM_INC_PATH_LIST) # Exported from Makefile. +STRIP_FROM_INC_PATH = # $(STRIP_FROM_INC_PATH_LIST) # Exported from Makefile. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't From 20d5f30ad47320f77510257256e417dcb64c6d83 Mon Sep 17 00:00:00 2001 From: Gunar Schorcht Date: Fri, 8 Feb 2019 14:30:54 +0100 Subject: [PATCH 2/4] doc: set FULL_PATH to yes Using FULL_PATH=yes avoids that paths in documentation seem to be arbitrary. --- doc/doxygen/riot.doxyfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index d2b5853831..705a8c18e0 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -140,7 +140,7 @@ INLINE_INHERITED_MEMB = NO # shortest path that makes the file name unique will be used # The default value is: YES. -FULL_PATH_NAMES = NO +FULL_PATH_NAMES = YES # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand From b18d312ef5442b963392e9f278c78afbdaf34967 Mon Sep 17 00:00:00 2001 From: Gunar Schorcht Date: Fri, 8 Feb 2019 14:32:03 +0100 Subject: [PATCH 3/4] doc: set STRIP_FROM_PATH Set STRIP_FROM_PATH=../../ avoids having the output depend on the location of the RIOT repo in the user's fs. --- doc/doxygen/riot.doxyfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index 705a8c18e0..e0e708afe8 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -152,7 +152,7 @@ FULL_PATH_NAMES = YES # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. -STRIP_FROM_PATH = +STRIP_FROM_PATH = ../../ # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which From e7b153cf80d2bc03f4d9daf4ca4181ff79c84a21 Mon Sep 17 00:00:00 2001 From: Gunar Schorcht Date: Thu, 17 Jan 2019 17:23:54 +0100 Subject: [PATCH 4/4] doc: remove *_params.h from EXCLUDE_PATTERNS --- doc/doxygen/riot.doxyfile | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index e0e708afe8..7e7bde2cd8 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -821,7 +821,6 @@ EXCLUDE_SYMLINKS = NO # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = */board/*/tools/* \ - *_params.h \ */cpu/atmega_common/include/sys/*.h \ */cpu/msp430_common/include/stdatomic.h \ */cpu/msp430_common/include/sys/*.h \