Diff: VL6180x.h

Revision:

1:3ebf8893b7e0

Parent:

0:4a5d4b4a40c4

Child:

2:31313127c530

--- a/VL6180x.h	Sun May 10 07:43:39 2015 +0000
+++ b/VL6180x.h	Sun May 10 16:59:09 2015 +0000
@@ -139,35 +139,48 @@
   * VL6180x destructor
   */
   ~VL6180x();
-  //Send mandatory settings as stated in ST datasheet.
-  // http://www.st.com/st-web-ui/static/active/en/resource/technical/document/application_note/DM00122600.pdf (Section 1.3)
+  /**
+  *Send mandatory settings as stated in ST datasheet.
+  * http://www.st.com/st-web-ui/static/active/en/resource/technical/document/application_note/DM00122600.pdf (Section 1.3)
+  */
   uint8_t VL6180xInit(void);
-  // Use default settings from ST data sheet section 9.
-  // http://www.st.com/st-web-ui/static/active/en/resource/technical/document/application_note/DM00122600.pdf
+  /**
+  * Use default settings from ST data sheet section 9.
+  * http://www.st.com/st-web-ui/static/active/en/resource/technical/document/application_note/DM00122600.pdf
+  */
   void VL6180xDefautSettings(void);
-
-  // Get Range distance in (mm)
+  /**
+  * Get Range distance in (mm)
+  */
   uint8_t getDistance();
-  // Get ALS level in Lux
+  /*
+  * Get ALS level in Lux
+  * @param vl6180x_als_gain gain setting for sensor
+  * @param sdl SCL pin
+  * @param addr addr of the I2C peripheral
+  */
   float getAmbientLight(vl6180x_als_gain VL6180X_ALS_GAIN);
-
-  //Load structure provided by the user with identification info
-  //Structure example:
-  // struct VL6180xIdentification
-  //  {
-  //   uint8_t idModel;
-  //   uint8_t idModelRevMajor;
-  //   uint8_t idModelRevMinor;
-  //   uint8_t idModuleRevMajor;
-  //   uint8_t idModuleRevMinor;
-  //   uint16_t idDate;
-  //   uint16_t idTime;
-  //   };
+  /*
+  *Load structure provided by the user with identification info
+  *Structure example:
+  * struct VL6180xIdentification
+  *  {
+  *   uint8_t idModel;
+  *   uint8_t idModelRevMajor;
+  *   uint8_t idModelRevMinor;
+  *   uint8_t idModuleRevMajor;
+  *   uint8_t idModuleRevMinor;
+  *   uint16_t idDate;
+  *   uint16_t idTime;
+  *   };
+  */
   void getIdentification(struct VL6180xIdentification *temp);
 
-  //Change the default address of the device to allow multiple
-  //sensors on the bus.  Can use up to 127 sensors. New address
-  //is saved in non-volatile device memory.
+  /*
+  * Change the default address of the device to allow multiple
+  * sensors on the bus.  Can use up to 127 sensors. New address
+  * is saved in non-volatile device memory.
+  */
   uint8_t changeAddress(uint8_t old_address, uint8_t new_address);