Diff: max31875.h

Revision:

1:98499c3dace6

Parent:

0:f51465145906

Child:

2:048eff228fd8

--- a/max31875.h	Sun Feb 03 23:50:17 2019 +0000
+++ b/max31875.h	Mon Feb 04 05:16:52 2019 +0000
@@ -181,27 +181,30 @@
     float read_reg_as_temperature(uint8_t reg);
 
     /** 
-     * @brief Writes the configuration register
+     * @brief Writes to the configuration register
+     * @param cfg - configurate word
      * @return 0 on success, negative number on failure
      */
      int write_cfg(uint16_t cfg);
 
     /** 
-     * @brief Writes the THYST register
+     * @brief Writes to the THYST register
+     * @param temperature - the temperature in Celsius degrees
      * @return 0 on success, negative number on failure
      */
      int write_trip_low(float temperature);
 
     /** 
-     * @brief Writes the TOS register
+     * @brief Writes to the TOS register
+     * @param temperature - the temperature in Celsius degrees
      * @return 0 on success, negative number on failure
      */
      int write_trip_high(float temperature);
 
     /** 
-     * @brief Converts Celcius degrees to Fahrenheit
+     * @brief Converts Celsius degrees to Fahrenheit
      * @param temp_c - the temperature in Celsius degrees
-     * @return 0 on success, negative number on failure
+     * @return temperature in Celsius degrees
      */
      float celsius_to_fahrenheit(float temp_c);