Diff: Devices/DS1920.hpp

Revision:

7:471901a04573

Parent:

6:a8c83a2e6fa4

diff -r a8c83a2e6fa4 -r 471901a04573 Devices/DS1920.hpp
--- a/Devices/DS1920.hpp	Wed Jan 23 13:11:04 2019 -0600
+++ b/Devices/DS1920.hpp	Mon Mar 04 08:10:00 2019 -0600
@@ -40,7 +40,7 @@
 
 namespace MaximInterface {
 
-/// DS1920 1-Wire Temperature iButton
+/// @brief DS1920 1-Wire Temperature iButton
 /// @details The iButton® temperature logger (DS1920) provides
 /// direct-to-digital 9-bit temperature readings over a range of
 /// -55°C to +100°C in 0.5° increments. The iButton communicates with
@@ -68,7 +68,7 @@
     this->selectRom = selectRom;
   }
 
-  /// Write Scratchpad Command
+  /// @brief Write Scratchpad Command
   /// @details If the result of a temperature measurement is higher
   /// than TH or lower than TL, an alarm flag inside the device is
   /// set. This flag is updated with every temperature measurement.
@@ -79,21 +79,21 @@
   MaximInterface_EXPORT error_code writeScratchpad(uint_least8_t th,
                                                    uint_least8_t tl);
 
-  /// Read Scratchpad Command
+  /// @brief Read Scratchpad Command
   /// @param[out] scratchpad Contents of scratchpad.
   MaximInterface_EXPORT error_code readScratchpad(Scratchpad::span scratchpad);
 
-  /// Copy Scratchpad Command
+  /// @brief Copy Scratchpad Command
   /// @details This command copies from the scratchpad into the
   /// EEPROM of the DS1920, storing the temperature trigger bytes
   /// in nonvolatile memory.
   MaximInterface_EXPORT error_code copyScratchpad();
 
-  /// Convert Temperature Command
+  /// @brief Convert Temperature Command
   /// @details This command begins a temperature conversion.
   MaximInterface_EXPORT error_code convertTemperature();
 
-  /// Recall Command
+  /// @brief Recall Command
   /// @details This command recalls the temperature trigger values
   /// stored in EEPROM to the scratchpad.
   MaximInterface_EXPORT error_code recallEeprom();
@@ -106,7 +106,8 @@
   const Sleep * sleep;
 };
 
-/// Reads the current temperature as an integer value.
+/// @brief Reads the current temperature as an integer value.
+/// @param ds1920 Device to read.
 /// @param[out] temperature Temperature in degrees Celsius multiplied by 2.
 MaximInterface_EXPORT error_code readTemperature(DS1920 & ds1920,
                                                  int & temperature);