Skip to content

include: drivers: sensor: enhance Doxygen documentation for INA2xx #110494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
kartben wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −0
Draft

include: drivers: sensor: enhance Doxygen documentation for INA2xx #110494

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions include/zephyr/drivers/sensor/ina2xx.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,22 @@
* SPDX-License-Identifier: Apache-2.0
*/

/**
* @file
* @brief Extended public API for the INA2xx family of current/power monitors.
* @ingroup ina2xx_interface
*/

#ifndef ZEPHYR_INCLUDE_DRIVERS_SENSOR_INA2XX_H_
#define ZEPHYR_INCLUDE_DRIVERS_SENSOR_INA2XX_H_

/**
* @brief TI INA2xx current/power monitor family
* @defgroup ina2xx_interface INA2XX
* @ingroup sensor_interface_ext
* @{
*/

#include <zephyr/drivers/sensor.h>

#ifdef __cplusplus
Expand All @@ -24,6 +37,7 @@ enum sensor_channel_ina2xx {
SENSOR_CHAN_INA2XX_CHARGE,
};

/** @brief Extended sensor attributes for the INA2xx family. */
enum sensor_attribute_ina2xx {
/** ADC configuration **/
SENSOR_ATTR_ADC_CONFIGURATION = SENSOR_ATTR_PRIV_START,
Expand All @@ -33,4 +47,8 @@ enum sensor_attribute_ina2xx {
}
#endif

/**
* @}
*/

#endif /* ZEPHYR_INCLUDE_DRIVERS_SENSOR_INA2XX_H_ */
Loading