Diff: Devices/DS2431.hpp

Revision:

7:471901a04573

Parent:

6:a8c83a2e6fa4

diff -r a8c83a2e6fa4 -r 471901a04573 Devices/DS2431.hpp
--- a/Devices/DS2431.hpp	Wed Jan 23 13:11:04 2019 -0600
+++ b/Devices/DS2431.hpp	Mon Mar 04 08:10:00 2019 -0600
@@ -40,7 +40,7 @@
 
 namespace MaximInterface {
 
-/// DS2431 1024-bit 1-Wire EEPROM
+/// @brief DS2431 1024-bit 1-Wire EEPROM
 /// @details The DS2431 is a 1024-bit, 1-Wire® EEPROM chip organized
 /// as four memory pages of 256 bits each. Data is written to an 8-byte
 /// scratchpad, verified, and then copied to the EEPROM memory. As a
@@ -70,26 +70,27 @@
     this->selectRom = selectRom;
   }
 
-  /// Reads block of data from EEPROM memory.
+  /// @brief Reads block of data from EEPROM memory.
   /// @param[in] beginAddress EEPROM memory address to start reading from.
   /// @param[out] data EEPROM data read from the device.
   MaximInterface_EXPORT error_code readMemory(Address beginAddress,
                                               span<uint_least8_t> data) const;
 
-  /// Writes 8 bytes to the scratchpad.
-  /// @param[in] targetAddress EEPROM memory address that this data.
-  /// will be copied to.  Must be on row boundary.
+  /// @brief Writes 8 bytes to the scratchpad.
+  /// @param[in] targetAddress
+  /// EEPROM memory address that this data will be copied to.
+  /// Must be on row boundary.
   /// @param[in] data Data to write to scratchpad.
   MaximInterface_EXPORT error_code writeScratchpad(Address targetAddress,
                                                    Scratchpad::const_span data);
 
-  /// Reads contents of scratchpad.
+  /// @brief Reads contents of scratchpad.
   /// @param[out] data Data read from scratchpad.
   /// @param[out] esByte E/S byte read before scratchpad data.
   MaximInterface_EXPORT error_code readScratchpad(Scratchpad::span data,
                                                   uint_least8_t & esByte);
 
-  /// Copies contents of scratchpad to EEPROM.
+  /// @brief Copies contents of scratchpad to EEPROM.
   /// @param[in] targetAddress EEPROM memory address that scratchpad
   /// will be copied to. Must be on row boundary.
   /// @param[in] esByte E/S byte from preceding Read Scratchpad command.
@@ -104,8 +105,10 @@
   const Sleep * sleep;
 };
 
+/// @brief
 /// Writes data to EEPROM using Write Scratchpad, Read Scratchpad,
 /// and Copy Scratchpad commands.
+/// @param device Device to write.
 /// @param[in] targetAddress EEPROM memory address to start writing at.
 /// @param[in] data Data to write to EEPROM.
 MaximInterface_EXPORT error_code writeMemory(DS2431 & device,