Add documentation

2022-02-15 19:33:22 +01:00
parent 2469d96127
commit 4ac0afc010
7 changed files with 164 additions and 12 deletions
@@ -2,6 +2,16 @@
 #define INC_MMR_CAN_OPTIMIZE_H_

 #ifdef __GNUC__
+/**
+ * @brief
+ * Tells the compiler that the given method
+ * must always be inlined.
+ *
+ * @example
+ * static always_inline int min(int a, int b) {
+ *   return a < b ? a : b;
+ * }
+ */
 #define always_inline inline __attribute__((always_inline))
 #else
 #define always_inline inline