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

doc: add documentation on RIOT_FILE_NOPATH

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

14
doc.txt
View File

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