Skip to content

Commit

Permalink
drivers: dac: doc: Cleanup Doxygen documentation
Browse files Browse the repository at this point in the history
Fixed Doxygen doc for dac_channel_cfg struct.

Signed-off-by: Benjamin Cabé <[email protected]>
  • Loading branch information
kartben authored and nashif committed Aug 9, 2023
1 parent e439ed2 commit 12e484c
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions include/zephyr/drivers/dac.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,17 @@ extern "C" {
*/

/**
* @struct dac_channel_cfg
* @brief Structure for specifying the configuration of a DAC channel.
*
* @param channel_id Channel identifier of the DAC that should be configured.
* @param resolution Desired resolution of the DAC (depends on device
* capabilities).
* @param buffered Enable output buffer for this channel. This is relevant for instance
* if the output is directly connected to the load, without an amplifier
* in between. The actual details on this are hardware dependent.
*/
struct dac_channel_cfg {
/** Channel identifier of the DAC that should be configured. */
uint8_t channel_id;
/** Desired resolution of the DAC (depends on device capabilities). */
uint8_t resolution;
/** Enable output buffer for this channel.
* This is relevant for instance if the output is directly connected to the load,
* without an amplifierin between. The actual details on this are hardware dependent.
*/
bool buffered;
};

Expand Down

0 comments on commit 12e484c

Please sign in to comment.