Mercurial > brewboard / file diff

--- a/components/esp32-ds18b20/include/ds18b20.h	Sat Oct 20 13:23:15 2018 +0200
+++ b/components/esp32-ds18b20/include/ds18b20.h	Sat Oct 20 17:09:48 2018 +0200
@@ -111,7 +111,6 @@
  *
  * @param[in] ds18b20_info Pointer to device info instance.
  * @param[in] bus Pointer to initialised 1-Wire bus instance.
- * @param[in] rom_code Device-specific ROM code to identify a device on the bus.
  */
 void ds18b20_init_solo(DS18B20_Info * ds18b20_info, const OneWireBus * bus);
 
@@ -151,6 +150,7 @@
 /**
  * @brief Start a temperature measurement conversion on a single device.
  * @param[in] ds18b20_info Pointer to device info instance.
+ * @return True if successfull.
  */
 bool ds18b20_convert(const DS18B20_Info * ds18b20_info);
 
@@ -165,7 +165,7 @@
 
 /**
  * @brief Wait for the maximum conversion time according to the current resolution of the device.
- * @param[in] bus Pointer to initialised bus instance.
+ * @param[in] ds18b20_info Pointer to device info instance. Must be initialised first.
  * @return An estimate of the time elapsed, in milliseconds. Actual elapsed time may be greater.
  */
 float ds18b20_wait_for_conversion(const DS18B20_Info * ds18b20_info);