Skip to content

Commit 2fb0458

Browse files
committed
Doxygen commnets for VL54L4CX
1 parent d36d2ba commit 2fb0458

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

src/components/i2c/drivers/WipperSnapper_I2C_Driver_VL53L4CX.h

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
#include <vl53l4cx_class.h>
2020
#include <vl53l4cx_def.h>
2121

22-
#define VL53_SHUTDOWN_PIN -1
23-
#define VL53_READING_DELAY 350
22+
#define VL53_SHUTDOWN_PIN -1 // No shutdown pin
23+
#define VL53_READING_DELAY 350 // Delay for reading data attempts
2424

2525
/**************************************************************************/
2626
/*!
@@ -179,9 +179,11 @@ class WipperSnapper_I2C_Driver_VL53L4CX : public WipperSnapper_I2C_Driver {
179179

180180
/*******************************************************************************/
181181
/*!
182-
@brief Gets the sensor_t data for the VL53L4CX sensor.
183-
@param sensor
184-
Pointer to an Adafruit_Sensor sensor_t structure.
182+
@brief Ensures the data is available for the VL53L4CX sensor.
183+
@param status
184+
Pointer to the returned error status
185+
@param NewDataReady
186+
Pointer to the returned data ready status
185187
*/
186188
/*******************************************************************************/
187189
void awaitDataReady(int &status, uint8_t &NewDataReady) {

0 commit comments

Comments
 (0)