kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-26 15:03:53 +01:00
Code Releases Activity

doc: add documentation on RIOT_FILE_RELATIVE

Browse Source
This commit is contained in:
Martine Lenders 2025-01-28 20:40:28 +01:00
parent e8be6eec09
commit 9e1437910f
No known key found for this signature in database
GPG Key ID: 2134D77A5336DD80
2 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc.txt
View File

@ -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.

3
doc/doxygen/riot.doxyfile
View File

@ -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