Diff: Devices/DS28E17.hpp

Revision:

7:471901a04573

Parent:

6:a8c83a2e6fa4

--- a/Devices/DS28E17.hpp	Wed Jan 23 13:11:04 2019 -0600
+++ b/Devices/DS28E17.hpp	Mon Mar 04 08:10:00 2019 -0600
@@ -40,7 +40,7 @@
 
 namespace MaximInterface {
 
-/// DS28E17 1-Wire®-to-I2C Master Bridge
+/// @brief DS28E17 1-Wire®-to-I2C Master Bridge
 /// @details The DS28E17 is a 1-Wire slave to I2C master bridge
 /// device that interfaces directly to I2C slaves at standard
 /// (100kHz max) or fast (400kHz max). Data transfers serially by
@@ -75,7 +75,7 @@
     this->selectRom = selectRom;
   }
 
-  /// Write Data With Stop command.
+  /// @brief Write Data With Stop command.
   /// @details Output on I2C: S, Address + Write, Write Data [1-255], P
   /// @param[in] I2C_addr
   /// I2C slave address. The least significant bit of the I2C
@@ -89,7 +89,7 @@
   writeDataWithStop(uint_least8_t I2C_addr, span<const uint_least8_t> data,
                     uint_least8_t * wr_status = NULL);
 
-  /// Write Data No Stop command.
+  /// @brief Write Data No Stop command.
   /// @details Output on I2C: S, Address + Write, Write Data [1-255]
   /// @param[in] I2C_addr
   /// I2C slave address. The least significant bit of the I2C address
@@ -103,7 +103,7 @@
   writeDataNoStop(uint_least8_t I2C_addr, span<const uint_least8_t> data,
                   uint_least8_t * wr_status = NULL);
 
-  /// Write Data Only command.
+  /// @brief Write Data Only command.
   /// @details Output on I2C: Write Data [1-255]
   /// @param[in] data I2C data to write with length 1-255.
   /// @param[out] wr_status
@@ -114,7 +114,7 @@
   writeDataOnly(span<const uint_least8_t> data,
                 uint_least8_t * wr_status = NULL);
 
-  /// Write Data Only With Stop command.
+  /// @brief Write Data Only With Stop command.
   /// @details Output on I2C: Write Data [1-255], P
   /// @param[in] data I2C data to write with length 1-255.
   /// @param[out] wr_status
@@ -125,7 +125,7 @@
   writeDataOnlyWithStop(span<const uint_least8_t> data,
                         uint_least8_t * wr_status = NULL);
 
-  /// Write, Read Data With Stop command.
+  /// @brief Write, Read Data With Stop command.
   /// @details Output on I2C:
   /// S, Slave Address + Write, Write Data [1-255],
   /// Sr, Address + Read, Read Data [1-255], P (NACK last read byte)
@@ -142,7 +142,7 @@
       uint_least8_t I2C_addr, span<const uint_least8_t> write_data,
       span<uint_least8_t> read_data, uint_least8_t * wr_status = NULL);
 
-  /// Read Data With Stop command.
+  /// @brief Read Data With Stop command.
   /// @details Output on I2C:
   /// S, Slave Address + Read, Read Data [1-255], P (NACK last read byte)
   /// @param[in]  I2C_addr
@@ -155,17 +155,17 @@
   /// Write to Configuration Register of DS28E17.
   MaximInterface_EXPORT error_code writeConfigReg(I2CSpeed speed);
 
-  /// Read the Configuration Register of DS28E17.
+  /// @brief Read the Configuration Register of DS28E17.
   /// @param[out] speed Speed read from configuration register.
   MaximInterface_EXPORT error_code readConfigReg(I2CSpeed & speed);
 
-  /// The Enable Sleep Mode command puts the device into a low current mode.
+  /// @brief Put the device into a low current mode.
   /// @details All 1-Wire communication is ignored until woken up. Immediately
   /// after the command, the device monitors the WAKEUP input pin and exits
   /// sleep mode on a rising edge.
   MaximInterface_EXPORT error_code enableSleepMode();
 
-  /// Read the Device Revision of DS28E17.
+  /// @brief Read the Device Revision of DS28E17.
   /// @details The upper nibble is the major revision,
   /// and the lower nibble is the minor revision.
   /// @param[out] rev Device Revision.