Skip to content

Commit 676673f

Browse files
kartbencfriedt
authored andcommitted
include: drivers: opamp: doxygen fixups
minor fixes to align docs with other drivers Signed-off-by: Benjamin Cabé <[email protected]>
1 parent bc02f34 commit 676673f

File tree

1 file changed

+26
-20
lines changed

1 file changed

+26
-20
lines changed

include/zephyr/drivers/opamp.h

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,18 @@
44
* SPDX-License-Identifier: Apache-2.0
55
*/
66

7+
/**
8+
* @file
9+
* @ingroup opamp_interface
10+
* @brief Main header file for OPAMP (Operational Amplifier) driver API.
11+
*/
12+
713
#ifndef ZEPHYR_INCLUDE_DRIVERS_OPAMP_H_
814
#define ZEPHYR_INCLUDE_DRIVERS_OPAMP_H_
915

1016
/**
11-
* @brief Opamp Interface
12-
* @defgroup opamp_interface Opamp Interface
17+
* @brief Interfaces for operational amplifiers (OPAMP).
18+
* @defgroup opamp_interface OPAMP
1319
* @since 4.3
1420
* @version 0.1.0
1521
* @ingroup io_interfaces
@@ -26,24 +32,24 @@ extern "C" {
2632

2733
/** @brief OPAMP gain factors. */
2834
enum opamp_gain {
29-
OPAMP_GAIN_1_7 = 0, /**< x 1/7. */
30-
OPAMP_GAIN_1_3, /**< x 1/3. */
31-
OPAMP_GAIN_1, /**< x 1. */
32-
OPAMP_GAIN_5_3, /**< x 5/3. */
33-
OPAMP_GAIN_2, /**< x 2. */
34-
OPAMP_GAIN_11_5, /**< x 11/5. */
35-
OPAMP_GAIN_3, /**< x 3. */
36-
OPAMP_GAIN_4, /**< x 4. */
37-
OPAMP_GAIN_13_3, /**< x 13/3. */
38-
OPAMP_GAIN_7, /**< x 7. */
39-
OPAMP_GAIN_8, /**< x 8. */
40-
OPAMP_GAIN_15, /**< x 15. */
41-
OPAMP_GAIN_16, /**< x 16. */
42-
OPAMP_GAIN_31, /**< x 31. */
43-
OPAMP_GAIN_32, /**< x 32. */
44-
OPAMP_GAIN_33, /**< x 33. */
45-
OPAMP_GAIN_63, /**< x 63. */
46-
OPAMP_GAIN_64, /**< x 64. */
35+
OPAMP_GAIN_1_7 = 0, /**< x 1/7. */
36+
OPAMP_GAIN_1_3, /**< x 1/3. */
37+
OPAMP_GAIN_1, /**< x 1. */
38+
OPAMP_GAIN_5_3, /**< x 5/3. */
39+
OPAMP_GAIN_2, /**< x 2. */
40+
OPAMP_GAIN_11_5, /**< x 11/5. */
41+
OPAMP_GAIN_3, /**< x 3. */
42+
OPAMP_GAIN_4, /**< x 4. */
43+
OPAMP_GAIN_13_3, /**< x 13/3. */
44+
OPAMP_GAIN_7, /**< x 7. */
45+
OPAMP_GAIN_8, /**< x 8. */
46+
OPAMP_GAIN_15, /**< x 15. */
47+
OPAMP_GAIN_16, /**< x 16. */
48+
OPAMP_GAIN_31, /**< x 31. */
49+
OPAMP_GAIN_32, /**< x 32. */
50+
OPAMP_GAIN_33, /**< x 33. */
51+
OPAMP_GAIN_63, /**< x 63. */
52+
OPAMP_GAIN_64, /**< x 64. */
4753
};
4854

4955
/**

0 commit comments

Comments
 (0)