Diff: MAX113XX_Pixi.h

Revision:

10:6efe114ef882

Parent:

9:094df3de3616

Child:

12:8054ee101bad

--- a/MAX113XX_Pixi.h	Sat May 06 00:22:47 2017 +0000
+++ b/MAX113XX_Pixi.h	Mon May 08 17:49:57 2017 +0000
@@ -36,7 +36,7 @@
 
 
 #include "mbed.h"
-#include "MAX11311Hex.h"
+#include "MAX11301Hex.h"
 
 
 /**
@@ -62,6 +62,7 @@
 {
     public:
     
+    ///Pixi devices
     enum Device_e
     {
         MAX11300 = 0,
@@ -126,6 +127,7 @@
         MODE_12
     };
     
+    ///Command results
     enum CmdResult_e
     {
         ///Failed operation
@@ -160,6 +162,10 @@
     ///@return Result of operation
     CmdResult_e singleEndedDACWrite(Ports_e port, const uint16_t data);
     
+    ///@brief Dumps pixi memory to provided Serial object
+    ///@param[in] ser - output device
+    ///@param[in] pixi - pixi device 
+    ///@return None
     void dumpPixiMemory(Serial &ser, MAX113XX_Pixi &pixi);
 
 protected:
@@ -207,6 +213,7 @@
     ///@brief MAX113XX_SPI Constructor
     ///@param[in] spiBus - reference to SPI bus for this device
     ///@param[in] cs - pin to be used for chip select
+    ///@param[in] device - pixi device; MAX11300, MAX11301,...
     ///@param[in] cnvrt - pin to be used for convert
     MAX113XX_SPI(SPI & spiBus, PinName cs, MAX113XX_Pixi::Device_e device, 
                  PinName cnvt);
@@ -240,6 +247,7 @@
 
     ///@brief MAX113XX_I2C Constructor
     ///@param[in] i2cBus - reference to I2C bus for this device
+    ///@param[in] device - pixi device; MAX11300, MAX11301,...
     ///@param[in] cnvrt - pin to be used for convert
     MAX113XX_I2C(I2C &i2cBus, MAX113XX_Pixi::Device_e device, PinName cnvt);