Add documentation for LM75 insanity...
[bertos.git] / bertos / drv / lm75.h
index 78a1c4053e5e50311e146a1c72af035a1666598d..e503b6cd977b0263df1c920e7ff9500c2b8b5358 100644 (file)
 #if COMPILER_C99
        #define lm75_read(...)        PP_CAT(lm75_read ## _, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
 #else
+       /**
+        * Read temperature from LM75 sensor.
+        *
+        * \note: Do not call this function faster than once every ~200ms, otherwise
+        *        the sensor will not have time to perform conversions and will
+        *        always return the same temperature value.
+        */
        #define lm75_read(args...)    PP_CAT(lm75_read ## _, COUNT_PARMS(args)) (args)
 #endif