Diff: Links/RomCommands.hpp

Revision:

7:471901a04573

Parent:

6:a8c83a2e6fa4

--- a/Links/RomCommands.hpp	Wed Jan 23 13:11:04 2019 -0600
+++ b/Links/RomCommands.hpp	Mon Mar 04 08:10:00 2019 -0600
@@ -31,7 +31,7 @@
 *******************************************************************************/
 
 /// @file
-/// ROM Commands for enumerating and selecting 1-Wire devices.
+/// @brief ROM Commands for enumerating and selecting 1-Wire devices.
 
 #ifndef MaximInterface_RomCommands
 #define MaximInterface_RomCommands
@@ -66,6 +66,7 @@
   }
 };
 
+/// @brief
 /// Set the search state to skip the current device family on the next
 /// Search ROM command.
 MaximInterface_EXPORT void skipCurrentFamily(SearchRomState & searchState);
@@ -74,43 +75,53 @@
 MaximInterface_EXPORT error_code verifyRom(OneWireMaster & master,
                                            RomId::const_span romId);
 
-/// Use Read ROM command to read ROM ID from device on bus.
-/// @note Only use this command with a single drop bus, data
-///       collisions will occur if more than 1 device on bus.
+/// @brief Use Read ROM command to read ROM ID from device on bus.
+/// @note
+/// Only use this command with a single-drop bus.
+/// Data collisions will occur if there is more than one device on the bus.
+/// @param master 1-Wire master for operation.
 /// @param[out] romId ROM ID read from device.
 MaximInterface_EXPORT error_code readRom(OneWireMaster & master,
                                          RomId::span romId);
 
-/// Issue Skip ROM command on bus.
-/// @note Only use this command with a single drop bus, data
-///       collisions will occur if more than 1 device on bus.
+/// @brief Issue Skip ROM command on bus.
+/// @note
+/// Only use this command with a single-drop bus.
+/// Data collisions will occur if there is more than one device on the bus.
 MaximInterface_EXPORT error_code skipRom(OneWireMaster & master);
 
-/// Use the Match ROM command to select the device by its known ID.
-/// @note This command causes all devices supporting Overdrive
-///       mode to switch to Overdrive timing.
+/// @brief Use the Match ROM command to select the device by its known ID.
+/// @note
+/// This command causes all devices supporting Overdrive mode to switch to
+/// Overdrive timing.
+/// @param master 1-Wire master for operation.
 /// @param[in] romId ROM ID of device to select.
 MaximInterface_EXPORT error_code matchRom(OneWireMaster & master,
                                           RomId::const_span romId);
 
-/// Issue Overdrive Skip ROM command on bus.
-/// @note This command causes all devices supporting Overdrive
-///       mode to switch to Overdrive timing.
-/// @note Only use this command with a single drop bus, data
-///       collisions will occur if more than 1 device on bus.
+/// @brief Issue Overdrive Skip ROM command on bus.
+/// @note
+/// This command causes all devices supporting Overdrive mode to switch to
+/// Overdrive timing.
+/// @note
+/// Only use this command with a single-drop bus.
+/// Data collisions will occur if there is more than one device on the bus.
 MaximInterface_EXPORT error_code overdriveSkipRom(OneWireMaster & master);
 
+/// @brief
 /// Use the Overdrive Match ROM command to select the device by its known ID.
+/// @param master 1-Wire master for operation.
 /// @param[in] romId ROM ID of device to select.
 MaximInterface_EXPORT error_code overdriveMatchRom(OneWireMaster & master,
                                                    RomId::const_span romId);
 
-/// Perform a Resume ROM command on bus.
-/// @details Resumes communication with the last device selected
-///          though a Match ROM or Search ROM operation.
+/// @brief Perform a Resume ROM command on bus.
+/// @details
+/// Resumes communication with the last device selected through a Match ROM or
+/// Search ROM operation.
 MaximInterface_EXPORT error_code resumeRom(OneWireMaster & master);
 
-/// Find device on the 1-Wire bus.
+/// @brief Find device on the 1-Wire bus.
 /// @details
 /// This command uses the Search ROM command to enumerate all 1-Wire devices in
 /// sequence. Begin with a new search state and continue using the same search