Diff: VEML6075.h

Revision:

2:0f3bb80aba40

Parent:

0:14ccc7ed49fa

Child:

3:d0d23d5abf34

--- a/VEML6075.h	Fri Feb 24 04:23:42 2017 +0000
+++ b/VEML6075.h	Fri May 19 04:42:59 2017 +0000
@@ -31,19 +31,97 @@
  /*
   * some member functions here (yet to be written)
   */
-float getUVA(void) ; // return float value of UVA
-float getUVA_CIE(void) ; // return float value of UVA_CIE
-float getUVB(void) ; // return float value of UVB
-float getUVB_CIE(void) ; // return float value of UVB_CIE
+/**
+ * get UVA 
+ * @param none
+ * @returns float UVA data
+ */
+float getUVA(void) ;
+
+/**
+ * get UVA_CIE 
+ * @param none
+ * @returns float UVA_CIE data
+ */
+float getUVA_CIE(void) ; 
+
+/** 
+ * get UVB
+ * @param none
+ * @returns float UVB data
+ */
+float getUVB(void) ; 
+
+/**
+ * get UVB_CIE
+ * @param none
+ * @returns float UVB_CIE data
+ */
+float getUVB_CIE(void) ;
+
+/**
+ * get UVConf
+ * @param uint8_t *uvconf
+ * @reurns none
+ */
 void getUVConf(uint8_t *uvconf) ;
+
+/**
+ * set UVConf
+ * @param uint8_t uvconf
+ * @returns none
+ */
 void setUVConf(uint8_t uvconf) ;
+
+/**
+ * get raw UVA data
+ * @param uint16_t *uvadata
+ * @returns none
+ */
 void getUVAData(uint16_t *uvadata) ;
+
+/**
+ * get raw UVB data
+ * @param uint16_t *rvbdata
+ * @returns none
+ */
 void getUVBData(uint16_t *uvbdata) ;
+
+/**
+ * get raw UVD data
+ * @param uint16_t *uvddata 
+ * @returns none
+ */
 void getUVDData(uint16_t *uvddata) ;
+
+/**
+ * get UVCOMP1 data
+ * @param *uint16_t *uvcomp1data
+ * @returns none
+ */
 void getUVCOMP1Data(uint16_t *uvcomp1data) ;
+
+/**
+ * get UVCOMP2 data
+ * @param *uint16_t *uvcomp2data
+ * @returns none
+ */
 void getUVCOMP2Data(uint16_t *uvcomp2data) ;
+
+/**
+ * get UVI UV Index
+ * @param none
+ * @returns float UVI
+ */
 float UVI(void) ;
+
+/**
+ * get device ID
+ * @param uint16_t *id device ID
+ * @returns none
+ */
 void getID(uint16_t *id) ;
+
 //  void cmdRead(uint8_t cmd, uint8_t *data, uint8_t numdata = 2) ;
 //  void cmdWrite(uint8_t cmd, uint8_t *data, uint8_t numdata = 2) ;