From 9e1437910fb2671e35eb656773cdd2811a7007fd Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Tue, 28 Jan 2025 20:40:28 +0100 Subject: [PATCH] doc: add documentation on RIOT_FILE_RELATIVE --- doc.txt | 12 ++++++++++++ doc/doxygen/riot.doxyfile | 3 +-- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/doc.txt b/doc.txt index 78dca2c188..9cafe140c3 100644 --- a/doc.txt +++ b/doc.txt @@ -59,6 +59,18 @@ # define DEVELHELP #endif +/** + * @def RIOT_FILE_RELATIVE + * @brief Provides the current filename relative to the RIOT base directory (RIOTBASE) + * @warning This only works within `*.c` and `*.cpp` files. For `*.h`/`*.hpp` files the + * source compiles, however, the including `*.c`/`*.cpp` file will be + * substituted. + * @see `__FILE__` for absolute filenames that also work with *.h files + */ +#if DOXYGEN +# define RIOT_FILE_RELATIVE +#endif + /** * @def CONFIG_THREAD_NAMES * @brief This global macro enable storage of thread names to help developers. diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index 5df85353f2..00a214d116 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -2304,8 +2304,7 @@ PREDEFINED = DOXYGEN \ MODULE_GNRC_SIXLOWPAN \ MODULE_GNRC_SIXLOWPAN_ND_ROUTER \ MODULE_GNRC_SIXLOWPAN_ND_BORDER_ROUTER \ - MODULE_GNRC_UDP \ - RIOT_FILE_RELATIVE + MODULE_GNRC_UDP # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The