Revision 1:ccc67c76fecb, committed 2019-07-30

Comitter:

joelvonrotz

Date:

Tue Jul 30 13:56:11 2019 +0000

Parent:

0:11ad6aaed10a

Commit message:

updated to mbed doc-format

Changed in this revision

diff -r 11ad6aaed10a -r ccc67c76fecb VL53L0X.h
--- a/VL53L0X.h	Tue Jul 30 13:49:02 2019 +0000
+++ b/VL53L0X.h	Tue Jul 30 13:56:11 2019 +0000
@@ -27,13 +27,13 @@
  * Something really cool about these sensors is the ability to change the I2C-address.
  * So you can hook multiple, identical sensors on the same I2C-line.
  * 
- * <h2>examples</h2>
+ * <h2>Examples</h2>
  * 
  * <h3>One Sensor</h3>
  * Using one sensor is pretty simple, connect the I2C-pins to the sensor (Shutdown should be pulled high
  * using a pull-up resistor).
  * 
- * <code>
+ * @code
  * #include "mbed.h"
  * #include "VL53L0X.h"
  *
@@ -55,13 +55,15 @@
  *     usb.printf("%4imm\n\r", vl_sensor.getRangeMillimeters());
  *   }
  * }
- * </code>
+ * @endcode
  * 
  * <h3>Multiple Sensors</h3>
- * Using one sensor is pretty simple, connect the I2C-pins to the sensor (Shutdown should be pulled high
- * using a pull-up resistor)
+ * To use multiple sensors, at the start of the programm every sensor needs to be
+ * turned off by setting their shutdown pin to low. Now one sensor is turned on,
+ * and configured with the new address. After that's done, the next sensor can be
+ * configured.
  * 
- * <code>
+ * @code
  * #include "mbed.h"
  * #include "VL53L0X.h"
  *
@@ -94,7 +96,7 @@
  *     usb.printf("1: %4imm 2: %4imm 3: %4imm) 4: %4imm 5: %4imm 6: %4imm)\n\r", results[0], results[1], results[2], results[3], results[4], results[5]);
  *   }
  * }
- * </code>
+ * @endcode
  * 
  * <strong>NOTE</strong> - The library is gigantic, so it is recommended to use this library
  * on devices with enough storage.