Made doxygen pass

adafruit · May 26, 2020 · f7d3e88 · f7d3e88
1 parent d16e560
commit f7d3e88
Showing 1 changed file with 15 additions and 11 deletions.
diff --git a/Adafruit_LIS2MDL.h b/Adafruit_LIS2MDL.h
@@ -16,12 +16,16 @@
 /*=========================================================================
     I2C ADDRESS/BITS
     -----------------------------------------------------------------------*/
-#define _ADDRESS_MAG 0x1E //< Default address
-#define _CHIP_ID 0x40     //< Chip ID from WHO_AM_I register
-#define LIS2MDL_MAG_LSB 1.5
-#define LIS2MDL_MILLIGAUSS_TO_MICROTESLA 0.1
+#define _ADDRESS_MAG 0x1E   //!< Default address
+#define _CHIP_ID 0x40       //!< Chip ID from WHO_AM_I register
+#define LIS2MDL_MAG_LSB 1.5 //!< Sensitivity
+#define LIS2MDL_MILLIGAUSS_TO_MICROTESLA                                       \
+  0.1 //!< Conversion rate of Milligauss to Microtesla
 /*=========================================================================*/
 
+/*!
+ * @brief LIS2MDL I2C register address bits
+ */
 typedef enum {
   LIS2MDL_OFFSET_X_REG_L = 0x45,
   LIS2MDL_OFFSET_X_REG_H = 0x46,
@@ -46,14 +50,14 @@ typedef enum {
 } lis2mdl_register_t;
 /*=========================================================================*/
 
-/*=========================================================================
-    MAGNETOMETER UPDATE RATE SETTINGS
-    -----------------------------------------------------------------------*/
+/*!
+ * @brief Magnetometer update rate settings
+ */
 typedef enum {
-  LIS2MDL_RATE_10_HZ,  //< 10 Hz
-  LIS2MDL_RATE_20_HZ,  //< 20 Hz
-  LIS2MDL_RATE_50_HZ,  //< 50 Hz
-  LIS2MDL_RATE_100_HZ, //< 100 Hz
+  LIS2MDL_RATE_10_HZ,  //!< 10 Hz
+  LIS2MDL_RATE_20_HZ,  //!< 20 Hz
+  LIS2MDL_RATE_50_HZ,  //!< 50 Hz
+  LIS2MDL_RATE_100_HZ, //!< 100 Hz
 } lis2mdl_rate_t;
 /*=========================================================================*/