Skip to content

Commit 919f6ff

Browse files
committed
docs(ads1x1x): add missing docstrings
1 parent b6d21e2 commit 919f6ff

File tree

2 files changed

+29
-9
lines changed

2 files changed

+29
-9
lines changed

drivers/ads1x1x/ads1x1x_saul.c

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,16 @@
11
/*
2-
* Copyright (C) 2017 OTA keys S.A.
3-
* 2018 Acutam Automation, LLC
4-
*
5-
* This file is subject to the terms and conditions of the GNU Lesser
6-
* General Public License v2.1. See the file LICENSE in the top level
7-
* directory for more details.
2+
* SPDX-FileCopyrightText: 2025 Baptiste Le Duc <[email protected]>
3+
* SPDX-License-Identifier: LGPL-2.1-only
84
*/
95

106
/**
11-
* @ingroup drivers_ads101x
7+
* @ingroup drivers_ads1x1x
128
* @{
139
*
1410
* @file
1511
* @brief ADS101x/111x adaption to the RIOT actuator/sensor interface
1612
*
17-
* @author Vincent Dupont <[email protected]>
18-
* @author Matthew Blue <[email protected]>
13+
* @author Baptiste Le Duc <[email protected]>
1914
*
2015
* @}
2116
*/

drivers/include/ads1x1x.h

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
1+
/*
2+
* SPDX-FileCopyrightText: 2025 Baptiste Le Duc <[email protected]>
3+
* SPDX-License-Identifier: LGPL-2.1-only
4+
*/
5+
16
#pragma once
27

8+
/**
9+
* @defgroup drivers_ads1x1x ADS101x/111x ADC device driver
10+
* @ingroup drivers_sensors
11+
* @ingroup drivers_saul
12+
* @brief I2C Analog-to-Digital Converter device driver
13+
*
14+
* This driver works with ADS1013-4-5 and ADS1113-4-5.
15+
*
16+
* This driver provides @ref drivers_saul capabilities.
17+
* @{
18+
*
19+
* @file
20+
* @brief ADS101x/111x ADC device driver
21+
*
22+
* ADC and alert functionality are separated into two devices to
23+
* prevent wasteful representations on muxed devices.
24+
*
25+
* @author Baptiste Le Duc <[email protected]>
26+
*/
27+
328
#ifdef __cplusplus
429
extern "C" {
530
#endif

0 commit comments

Comments
 (0)