From e2f43682b2eb15c5196aec91a2f6bc2c1487fc62 Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Tue, 28 Jan 2025 20:48:01 +0100 Subject: [PATCH] doc: add documentation on RIOT_FILE_NOPATH --- doc.txt | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc.txt b/doc.txt index 9cafe140c3..94cd317455 100644 --- a/doc.txt +++ b/doc.txt @@ -66,11 +66,25 @@ * source compiles, however, the including `*.c`/`*.cpp` file will be * substituted. * @see `__FILE__` for absolute filenames that also work with *.h files + * @see @ref RIOT_FILE_NOPATH */ #if DOXYGEN # define RIOT_FILE_RELATIVE #endif +/** + * @def RIOT_FILE_NOPATH + * @brief Provides the current filename without the parent directory path + * @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 + * @see @ref RIOT_FILE_RELATIVE + */ +#if DOXYGEN +# define RIOT_FILE_NOPATH +#endif + /** * @def CONFIG_THREAD_NAMES * @brief This global macro enable storage of thread names to help developers.