Diff: Slaves/Bridges/DS28E17/DS28E17.h

Revision:

93:e496a45ce796

Parent:

86:2ce08ca58b9e

Child:

95:5ebdf5d955f4

diff -r aa40c49b8563 -r e496a45ce796 Slaves/Bridges/DS28E17/DS28E17.h
--- a/Slaves/Bridges/DS28E17/DS28E17.h	Mon Jun 20 20:02:28 2016 +0000
+++ b/Slaves/Bridges/DS28E17/DS28E17.h	Fri Jun 24 21:06:46 2016 +0000
@@ -40,10 +40,29 @@
 namespace OneWire
 {
     class OneWireMaster;
-
+    
+    /**
+    * @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 
+    * means of the 1-Wire® protocol, which requires only a single data 
+    * lead and a ground return. Every DS28E17 is guaranteed to have a 
+    * unique 64-bit ROM registration number that serves as a node 
+    * address in the 1-Wire network. Multiple DS28E17 devices can 
+    * coexist with other devices in the 1-Wire network and be accessed 
+    * individually without affecting other devices. The DS28E17 allows 
+    * using complex I2C devices such as display controllers, ADCs, DACs,
+    * I2C sensors, etc. in a 1-Wire environment. Each self-timed DS28E17 
+    * provides 1-Wire access for a single I2C interface.
+    *
+    */
     class DS28E17 : public OneWireSlave
     {
     public:
+        
+        ///Result of all operations
         enum CmdResult
         {
             Success,