Skip to content

Commit

Permalink
doc: add documentation on RIOT_FILE_NOPATH
Browse files Browse the repository at this point in the history
  • Loading branch information
miri64 committed Jan 28, 2025
1 parent 9e14379 commit e2f4368
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit e2f4368

Please sign in to comment.