doc: add documentation on RIOT_FILE_NOPATH

miri64 · miri64 · commit e2f43682b2eb · 2025-01-28T20:58:48.000+01:00
diff --git 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.
