Maxim Integrated / MaximInterface

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#

Diff: Devices/DS18B20.hpp

Revision:
6:471901a04573
Parent:
5:a8c83a2e6fa4
--- a/Devices/DS18B20.hpp	Wed Jan 23 13:11:04 2019 -0600
+++ b/Devices/DS18B20.hpp	Mon Mar 04 08:10:00 2019 -0600
@@ -40,7 +40,7 @@
 
 namespace MaximInterface {
 
-/// DS18B20 Programmable Resolution 1-Wire Digital Thermometer
+/// @brief DS18B20 Programmable Resolution 1-Wire Digital Thermometer
 /// @details The DS18B20 digital thermometer provides 9-bit to 12-bit
 /// Celsius temperature measurements and has an alarm function with
 /// nonvolatile user-programmable upper and lower trigger points. The
@@ -125,6 +125,7 @@
 };
 
 /// Reads the current temperature as an integer value with decimal.
+/// @param ds18b20 Device to read.
 /// @param[out] temperature Temperature in degrees Celsius multiplied by 16.
 MaximInterface_EXPORT error_code readTemperature(DS18B20 & ds18b20,
                                                  int & temperature);