Skip to content

Commit 8d07b22

Browse files
committed
driver: adapt comments to Doxygen convention
1 parent e24b925 commit 8d07b22

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

drivers/include/ads1115.h

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -42,30 +42,30 @@ enum {
4242
* @brief Operational status bit in write operations
4343
*/
4444
typedef enum {
45-
ADS1115_WRITE_NO_EFFECT = 0, /**<no effect> */
46-
ADS1115_WRITE_SINGLE_SHOT = 1, /**<start a single-shot conversion when in power-down mode> */
45+
ADS1115_WRITE_NO_EFFECT = 0, /**< No effect */
46+
ADS1115_WRITE_SINGLE_SHOT = 1, /**< Start a single-shot conversion when in power-down mode */
4747
} ads1115_os_write_t;
4848

4949
/**
5050
* @brief Operational status bit in read operations
5151
*/
5252
typedef enum {
5353
ADS1115_READ_BUSY = 0, /**<device is currently performing a conversion> */
54-
ADS1115_READ_IDLE = 1, /**<device is not performing a conversion> */
54+
ADS1115_READ_IDLE = 1, /**< Device is not performing a conversion */
5555
} ads1115_os_read_t;
5656

5757
/**
5858
* @brief Input multiplexer configuration
5959
*/
6060
typedef enum {
61-
ADS1115_MUX_AIN0_AIN1 = 0, /**<AIN0 - AIN1 differential input (AINp = AIN0 && AINn = AIN1) (default)*/
62-
ADS1115_MUX_AIN0_AIN3 = 1, /**<AIN0 - AIN3 differential input (AINp = AIN0 && AINn = AIN3) */
63-
ADS1115_MUX_AIN1_AIN3 = 2, /**<AIN1 - AIN3 differential input (AINp = AIN1 && AINn = AIN3) */
64-
ADS1115_MUX_AIN2_AIN3 = 3, /**<AIN2 - AIN3 differential input (AINp = AIN2 && AINn = AIN3) */
65-
ADS1115_MUX_AIN0 = 4, /**<AIN0 single-ended input (AINp = AIN0 && AINn = GND) */
66-
ADS1115_MUX_AIN1 = 5, /**<AIN1 single-ended input (AINp = AIN1 && AINn = GND) */
67-
ADS1115_MUX_AIN2 = 6, /**<AIN2 single-ended input (AINp = AIN2 && AINn = GND) */
68-
ADS1115_MUX_AIN3 = 7 /**<AIN3 single-ended input (AINp = AIN3 && AINn = GND) */
61+
ADS1115_MUX_AIN0_AIN1 = 0, /**< AIN0 - AIN1 differential input (AINp = AIN0 && AINn = AIN1) (default) */
62+
ADS1115_MUX_AIN0_AIN3 = 1, /**< AIN0 - AIN3 differential input (AINp = AIN0 && AINn = AIN3) */
63+
ADS1115_MUX_AIN1_AIN3 = 2, /**< AIN1 - AIN3 differential input (AINp = AIN1 && AINn = AIN3) */
64+
ADS1115_MUX_AIN2_AIN3 = 3, /**< AIN2 - AIN3 differential input (AINp = AIN2 && AINn = AIN3) */
65+
ADS1115_MUX_AIN0 = 4, /**< AIN0 single-ended input (AINp = AIN0 && AINn = GND) */
66+
ADS1115_MUX_AIN1 = 5, /**< AIN1 single-ended input (AINp = AIN1 && AINn = GND) */
67+
ADS1115_MUX_AIN2 = 6, /**< AIN2 single-ended input (AINp = AIN2 && AINn = GND) */
68+
ADS1115_MUX_AIN3 = 7 /**< AIN3 single-ended input (AINp = AIN3 && AINn = GND) */
6969
} ads1115_mux_t;
7070

7171
/**

0 commit comments

Comments
 (0)