Diff: VEML6040.h

Revision:

3:c6614597c135

Parent:

1:5540b216acfc

Child:

4:f5b142e3fe79

--- a/VEML6040.h	Fri May 19 02:50:57 2017 +0000
+++ b/VEML6040.h	Fri May 19 04:24:33 2017 +0000
@@ -31,14 +31,67 @@
  /*
   * some member functions here (yet to be written)
   */
+/**
+ * get Red
+ * @param none
+ * @returns float value of Red
+ */
 float getR(void) ; // return float value of Red
+
+/**
+ * get Green
+ * @param none
+ * @returns float value of Green
+ */
 float getG(void) ; // return float value of Green
+
+/**
+ * get Blue
+ * @param none
+ * @returns float value of Blue
+ */
 float getB(void) ; // return float value of Blue
+
+/**
+ * get White
+ * @param none
+ * @returns float value of White
+ */
 float getW(void) ; // return float value of White
+
+/**
+ * get CCT(McCAMY FORMULA) value X
+ * @param none
+ * @returns float CCT value X
+ */
 float getX(void) ; // return float value of X
+
+/** 
+ * get CCT(McCAMY FOMULA) value Y
+ * @param none
+ * @returns float CCT value Y
+ */
 float getY(void) ; // return float value of Y
+
+/**
+ * get CCT(McCAMY FOMULA) value Z
+ * @param none
+ * @returns float CCT value Z
+ */
 float getZ(void) ; // return float value of Z
+
+/**
+ * get CIE1931 X
+ * @param none
+ * @returns float CIE1931 X
+ */
 float getCIEX(void) ; // return float value of CIE1931_x
+
+/**
+ * get CIE1931 Y
+ * @param none
+ * @returns float CIE1931 Y
+ */
 float getCIEY(void) ; // return float value of CIE1931_y
 
 void getCOLORConf(uint8_t *colorconf) ;
@@ -46,13 +99,48 @@
 // void getX(uint8_t *X) ;
 // void getY(uint8_t *Y) ;
 // void getZ(uint8_t *Z) ;
+/**
+ * get raw Red data
+ * @param uint16_t *rdata 
+ * @returns none
+ */
 void getRData(uint16_t *rdata) ;
+
+/**
+ * get raw Green data
+ * @param uint16_t *gdata
+ * @returns none
+ */
 void getGData(uint16_t *gdata) ;
+
+/**
+ * get raw Blue data
+ * @param uint16_t *bdata
+ * @returns none
+ */
 void getBData(uint16_t *bdata) ;
+
+/**
+ * get raw White data
+ * @param uint16_t *wdata
+ * @returns none
+ */
 void getWData(uint16_t *wdata) ;
+
 // void getCCTiData(uint16_t *cctidata) ;
+/**
+ * get CCTi data for CCT (EMPIRICAL APPROACH)
+ * @param none
+ * @returns float CCTi data
+ */ 
 float getCCTiData(void) ;
 // void getCCTData(uint16_t *cctdata) ;
+
+/**
+ * get CCT data (EMPIRICAL APPROACH)
+ * @param none
+ * @returns float CCD data
+ */
 float getCCTData(void) ;
 //  void cmdRead(uint8_t cmd, uint8_t *data, uint8_t numdata = 2) ;
 //  void cmdWrite(uint8_t cmd, uint8_t *data, uint8_t numdata = 2) ;