Skip to content

Commit f19e8c9

Browse files
committed
src/compat.h: Add doxygen docs for FPSTR() macro to keep doxygen quiet
1 parent 27d7e02 commit f19e8c9

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/ace_routine/compat.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,11 @@ class __FlashStringHelper;
7373
#else
7474
#warning Untested platform, AceRoutine may still work...
7575
#ifndef FPSTR
76+
/**
77+
* A macro that converts a `const char*` that already points to a PROGMEM
78+
* string to a `const __FlashStringHelper*` which can be passed to
79+
* overloaded functions and methods.
80+
*/
7681
#define FPSTR(p) (reinterpret_cast<const __FlashStringHelper *>(p))
7782
#endif
7883
#include <avr/pgmspace.h>

0 commit comments

Comments
 (0)