Diff: Links/OneWireMaster.hpp

Revision:

7:471901a04573

Parent:

6:a8c83a2e6fa4

--- a/Links/OneWireMaster.hpp	Wed Jan 23 13:11:04 2019 -0600
+++ b/Links/OneWireMaster.hpp	Mon Mar 04 08:10:00 2019 -0600
@@ -65,10 +65,13 @@
 
   virtual ~OneWireMaster() {}
 
+  /// @brief
   /// Reset all of the devices on the 1-Wire bus and check for a presence pulse.
-  /// @returns NoSlaveError if reset was performed but no presence pulse was detected.
+  /// @returns
+  /// NoSlaveError if reset was performed but no presence pulse was detected.
   virtual error_code reset() = 0;
 
+  /// @brief
   /// Send and receive one bit of communication and set a new level on the
   /// 1-Wire bus.
   /// @param[in,out] sendRecvBit
@@ -76,24 +79,26 @@
   /// @param afterLevel Level to set the 1-Wire bus to after communication.
   virtual error_code touchBitSetLevel(bool & sendRecvBit, Level afterLevel) = 0;
 
+  /// @brief
   /// Send one byte of communication and set a new level on the 1-Wire bus.
   /// @param sendByte Byte to send on the 1-Wire bus.
   /// @param afterLevel Level to set the 1-Wire bus to after communication.
   MaximInterface_EXPORT virtual error_code
   writeByteSetLevel(uint_least8_t sendByte, Level afterLevel);
 
+  /// @brief
   /// Receive one byte of communication and set a new level on the 1-Wire bus.
   /// @param recvByte Buffer to receive the data from the 1-Wire bus.
   /// @param afterLevel Level to set the 1-Wire bus to after communication.
   MaximInterface_EXPORT virtual error_code
   readByteSetLevel(uint_least8_t & recvByte, Level afterLevel);
 
-  /// Send a block of communication on the 1-Wire bus.
+  /// @brief Send a block of communication on the 1-Wire bus.
   /// @param[in] sendBuf Buffer to send on the 1-Wire bus.
   MaximInterface_EXPORT virtual error_code
   writeBlock(span<const uint_least8_t> sendBuf);
 
-  /// Receive a block of communication on the 1-Wire bus.
+  /// @brief Receive a block of communication on the 1-Wire bus.
   /// @param[out] recvBuf Buffer to receive the data from the 1-Wire bus.
   MaximInterface_EXPORT virtual error_code
   readBlock(span<uint_least8_t> recvBuf);
@@ -104,16 +109,17 @@
   /// Set the 1-Wire bus level.
   virtual error_code setLevel(Level newLevel) = 0;
 
-  /// 1-Wire Triplet operation.
+  /// @brief 1-Wire Triplet operation.
   /// @details Perform one bit of a 1-Wire search. This command
   /// does two read bits and one write bit. The write bit is either
   /// the default direction (all devices have same bit) or in case
   /// of a discrepancy, the data.writeBit parameter is used.
-  ///@param[in,out] data
+  /// @param[in,out] data
   /// Input with desired writeBit in case both read bits are zero.
   /// Output with all data fields set.
   MaximInterface_EXPORT virtual error_code triplet(TripletData & data);
 
+  /// @brief
   /// Send one bit of communication and set a new level on the 1-Wire bus.
   /// @param sendBit Bit to send on the 1-Wire bus.
   /// @param afterLevel Level to set the 1-Wire bus to after communication.
@@ -121,6 +127,7 @@
     return touchBitSetLevel(sendBit, afterLevel);
   }
 
+  /// @brief
   /// Receive one bit of communication and set a new level on the 1-Wire bus.
   /// @param[out] recvBit Received data from the 1-Wire bus.
   /// @param afterLevel Level to set the 1-Wire bus to after communication.