8000 drivers/include: fixing order of doxygen tags and header guards by KSKNico · Pull Request #21325 · RIOT-OS/RIOT · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

drivers/include: fixing order of doxygen tags and header guards #21325

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.

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

Merged
merged 1 commit into from
Mar 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions drivers/include/ad7746.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
* directory for more details.
*/

#ifndef AD7746_H
#define AD7746_H

/**
* @defgroup drivers_ad7746 AD7746 Capacitance-to-digital converter driver
* @ingroup drivers_sensors
Expand Down Expand Up @@ -41,9 +44,6 @@
* @author Leandro Lanzieri <leandro.lanzieri@haw-hamburg.de>
*/

#ifndef AD7746_H
#define AD7746_H

#ifdef __cplusplus
extern "C" {
#endif
Expand Down Expand Up @@ -331,5 +331,5 @@ int ad7746_set_cap_sr(const ad7746_t *dev, ad7746_cap_sample_rate_t sr);
}
#endif

#endif /* AD7746_H */
/** @} */
#endif /* AD7746_H */
8 changes: 4 additions & 4 deletions drivers/include/adcxx1c.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
* directory for more details.
*/

#ifndef ADCXX1C_H
#define ADCXX1C_H

/**
* @defgroup drivers_adcxx1c ADCXX1C ADC device driver
* @ingroup drivers_sensors
Expand All @@ -23,9 +26,6 @@
* @author Vincent Dupont <vincent@otakeys.com>
*/

#ifndef ADCXX1C_H
#define ADCXX1C_H

#ifdef __cplusplus
extern "C" {
#endif
Expand Down Expand Up @@ -181,5 +181,5 @@ int adcxx1c_get_and_clear_alert(const adcxx1c_t *dev);
}
#endif

#endif /* ADCXX1C_H */
/** @} */
#endif /* ADCXX1C_H */
8 changes: 4 additions & 4 deletions drivers/include/ads101x.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
* directory for more details.
*/

#ifndef ADS101X_H
#define ADS101X_H

/**
* @defgroup drivers_ads101x ADS101x/111x ADC device driver
* @ingroup drivers_sensors
Expand All @@ -28,9 +31,6 @@
* @author Matthew Blue <matthew.blue.neuro@gmail.com>
*/

#ifndef ADS101X_H
#define ADS101X_H

#ifdef __cplusplus
extern "C" {
#endif
Expand Down Expand Up @@ -181,5 +181,5 @@ int ads101x_set_alert_parameters(const ads101x_alert_t *dev,
}
#endif

#endif /* ADS101X_H */
/** @} */
#endif /* ADS101X_H */
8 changes: 4 additions & 4 deletions < 10000 span class="Truncate"> drivers/include/adt7310.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
* directory for more details.
*/

#ifndef ADT7310_H
#define ADT7310_H

/**
* @defgroup drivers_adt7310 ADT7310 SPI temperature sensor
* @ingroup drivers_sensors
Expand Down Expand Up @@ -47,9 +50,6 @@
* @author Joakim Nohlgård <joakim.nohlgard@eistec.se>
*/

#ifndef ADT7310_H
#define ADT7310_H

#include <stdint.h>
#include <stdbool.h>
#include "periph/spi.h"
Expand Down Expand Up @@ -77,7 +77,7 @@
*/
#define ADT7310_CONF_FAULT_QUEUE_MASK (0x03)
#define ADT7310_CONF_FAULT_QUEUE_SHIFT (0)
#define ADT7310_CONF_FAULT_QUEUE(x) (((x) << ADT7310_CONF_FAULT_QUEUE_SHIFT) & ADT7310_CONF_FAULT_QUEUE_MASK)

Check warning on line 80 in drivers/include/adt7310.h

View workflow job for this annotation

GitHub Actions / static-tests

line is longer than 100 characters
#define ADT7310_CONF_CT_POL_MASK (0x04)
#define ADT7310_CONF_CT_POL_SHIFT (2)
#define ADT7310_CONF_CT_POL(x) (((x) << ADT7310_CONF_CT_POL_SHIFT) & ADT7310_CONF_CT_POL_MASK)
Expand All @@ -86,13 +86,13 @@
#define ADT7310_CONF_INT_POL(x) (((x) << ADT7310_CONF_INT_POL_SHIFT) & ADT7310_CONF_INT_POL_MASK)
#define ADT7310_CONF_INTCT_MODE_MASK (0x10)
#define ADT7310_CONF_INTCT_MODE_SHIFT (4)
#define ADT7310_CONF_INTCT_MODE(x) (((x) << ADT7310_CONF_INTCT_MODE_SHIFT) & ADT7310_CONF_INTCT_MODE_MASK)

Check warning on line 89 in drivers/include/adt7310.h

View workflow job for this annotation

GitHub Actions / static-tests

line is longer than 100 characters
#define ADT7310_CONF_OPERATION_MODE_MASK (0x60)
#define ADT7310_CONF_OPERATION_MODE_SHIFT (5)
#define ADT7310_CONF_OPERATION_MODE(x) (((x) << ADT7310_CONF_OPERATION_MODE_SHIFT) & ADT7310_CONF_OPERATION_MODE_MASK)

Check warning on line 92 in drivers/include/adt7310.h

View workflow job for this annotation

GitHub Actions / static-tests

line is longer than 100 characters
#define ADT7310_CONF_RESOLUTION_MASK (0x80)
#define ADT7310_CONF_RESOLUTION_SHIFT (7)
#define ADT7310_CONF_RESOLUTION(x) (((x) << ADT7310_CONF_RESOLUTION_SHIFT) & ADT7310_CONF_RESOLUTION_MASK)

Check warning on line 95 in drivers/include/adt7310.h

View workflow job for this annotation

GitHub Actions / static-tests

line is longer than 100 characters

/**
* @brief Continuous operation mode
Expand Down Expand Up @@ -177,5 +177,5 @@
}
#endif

#endif /* ADT7310_H */
/** @} */
#endif /* ADT7310_H */
8 changes: 4 additions & 4 deletions drivers/include/adxl345.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
* directory for more details.
*/

#ifndef ADXL345_H
#define ADXL345_H

/**
* @defgroup drivers_adxl345 ADXL345 3-Axis accelerometer
* @ingroup drivers_sensors
Expand All @@ -21,9 +24,6 @@
* @author Dylan Laduranty <dylan.laduranty@mesotic.com>
*/

#ifndef ADXL345_H
#define ADXL345_H

#ifdef __cplusplus
extern "C" {
#endif
Expand Down Expand Up @@ -245,5 +245,5 @@ void adxl345_set_fifo_mode(const adxl345_t *dev, uint8_t mode,
}
#endif

#endif /* ADXL345_H */
/** @} */
#endif /* ADXL345_H */
8 changes: 4 additions & 4 deletions drivers/include/aip31068.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
* directory for more details.
*/

#ifndef AIP31068_H
#define AIP31068_H

/**
* @defgroup drivers_aip31068 AIP31068 I2C LCD controller
* @ingroup drivers_display
Expand All @@ -17,9 +20,6 @@
* @file
*/

#ifndef AIP31068_H
#define AIP31068_H

#ifdef __cplusplus
extern "C"
{
Expand Down Expand Up @@ -422,5 +422,5 @@ int aip31068_print_char(aip31068_t *dev, char c);
}
#endif

#endif /* AIP31068_H */
/** @} */
#endif /* AIP31068_H */
8 changes: 4 additions & 4 deletions drivers/include/apa102.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
* directory for more details.
*/

#ifndef APA102_H
#define APA102_H

/**
* @defgroup drivers_apa102 APA102 RGB LED
* @ingroup drivers_actuators
Expand All @@ -18,9 +21,6 @@
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/

#ifndef APA102_H
#define APA102_H

#include "color.h"
#include "periph/gpio.h"

Expand Down Expand Up @@ -68,5 +68,5 @@ void apa102_load_rgba(const apa102_t *dev, const color_rgba_t vals[]);
}
#endif

#endif /* APA102_H */
/** @} */
#endif /* APA102_H */
8 changes: 4 additions & 4 deletions drivers/include/apds99xx.h
F438
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
* directory for more details.
*/

#ifndef APDS99XX_H
#define APDS99XX_H

/**
* @defgroup drivers_apds99xx APDS99XX proximity and ambient light sensors
* @ingroup drivers_sensors
Expand Down Expand Up @@ -97,7 +100,7 @@
* If apds99xx_params_t::wait_steps is 0, waiting is disabled. The time per
* step ```t_wait_step``` depends on used sensor and is available as the
* define #APDS99XX_T_WAIT_STEP for calculations by the application.
* Sensor<br> | t_als_step<br>APDS99XX_T_WAIT_STEP | t_wait (wait_long=0) <br> | t_wait (wait_long=1) <br>

Check warning on line 103 in drivers/include/apds99xx.h

View workflow job for this annotation

GitHub Actions / static-tests

line is longer than 100 characters
* ---------- | ------- | ---------------------------| ------------------------
* APDS9900 | 2.72 ms | ```wait_steps``` * 2.72 ms | ```wait_steps``` * 12 * 2.72 ms
* APDS9901 | 2.72 ms | ```wait_steps``` * 2.72 ms | ```wait_steps``` * 12 * 2.72 ms
Expand Down Expand Up @@ -132,7 +135,7 @@
* application
*
* ALS uses the gain specified by parameter apds99xx_params_t::als_gain.
* Sensor<br> | t_als_step<br>APDS99XX_T_ALS_STEP | cnts_p_step<br>APDS99XX_CNTS_P_STEP | t_als_int<br> | cnt_als_max<br>

Check warning on line 138 in drivers/include/apds99xx.h

View workflow job for this annotation

GitHub Actions / static-tests

line is longer than 100 characters
* -------- | ------- | ---- | ----------------------- | ----------------
* APDS9900 | 2.72 ms | 1023 | ```als_steps``` * 2.72 ms | ```als_steps``` * 1023
* APDS9901 | 2.72 ms | 1023 | ```als_steps``` * 2.72 ms | ```als_steps``` * 1023
Expand Down Expand Up @@ -199,9 +202,6 @@
* @file
*/

#ifndef APDS99XX_H
#define APDS99XX_H

#ifdef __cplusplus
extern "C"
{
Expand Down Expand Up @@ -683,5 +683,5 @@
}
#endif

#endif /* APDS99XX_H */
/** @} */
#endif /* APDS99XX_H */
8 changes: 4 additions & 4 deletions drivers/include/arduino_pinmap.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
* directory for more details.
*/

#ifndef ARDUINO_PINMAP_H
#define ARDUINO_PINMAP_H

/**
* @ingroup drivers
* @{
Expand All @@ -18,9 +21,6 @@
* @author Marian Buschsieweke <marian.buschsieweke@posteo.net>
*/

#ifndef ARDUINO_PINMAP_H
#define ARDUINO_PINMAP_H

#include "arduino_iomap.h"

#ifdef __cplusplus
Expand All @@ -34,5 +34,5 @@ extern "C" {
}
#endif

#endif /* ARDUINO_PINMAP_H */
/** @} */
#endif /* ARDUINO_PINMAP_H */
8 changes: 4 additions & 4 deletions drivers/include/at.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
* directory for more details.
*/

#ifndef AT_H
#define AT_H

/**
* @defgroup drivers_at AT (Hayes) command set library
* @ingroup drivers_misc
Expand Down Expand Up @@ -111,9 +114,6 @@
* @author Kaspar Schleiser <kaspar@schleiser.de>
*/

#ifndef AT_H
#define AT_H

#include <stdint.h>
#include <unistd.h>
#include <stdbool.h>
Expand Down Expand Up @@ -662,5 +662,5 @@ void at_postprocess_urc_all(at_dev_t *dev, char *buf);
}
#endif

#endif /* AT_H */
/** @} */
#endif /* AT_H */
8 changes: 4 additions & 4 deletions drivers/include/at24cxxx.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
* directory for more details.
*/

#ifndef AT24CXXX_H
#define AT24CXXX_H

/**
* @defgroup drivers_at24cxxx AT24CXXX EEPROM unit
* @ingroup drivers_misc
Expand Down Expand Up @@ -65,9 +68,6 @@
*
*/

#ifndef AT24CXXX_H
#define AT24CXXX_H

#include <stdint.h>

#include "periph/gpio.h"
Expand Down Expand Up @@ -240,5 +240,5 @@ int at24cxxx_disable_write_protect(const at24cxxx_t *dev);
}
#endif

#endif /* AT24CXXX_H */
/** @} */
#endif /* AT24CXXX_H */
8 changes: 4 additions & 4 deletions drivers/include/at24mac.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
* directory for more details.
*/

#ifndef AT24MAC_H
#define AT24MAC_H

/**
* @defgroup drivers_at24mac AT24MAC unique ID chip
* @ingroup drivers_misc
Expand All @@ -17,9 +20,6 @@
* @author Benjamin Valentin <benjamin.valentin@ml-pa.com>
*/

#ifndef AT24MAC_H
#define AT24MAC_H

#include <stdint.h>
#include "net/eui48.h"
#include "net/eui64.h"
Expand Down Expand Up @@ -101,5 +101,5 @@ at24mac_type_t at24mac_get_type(at24mac_t dev);
}
#endif

#endif /* AT24MAC_H */
/** @} */
#endif /* AT24MAC_H */
8 changes: 4 additions & 4 deletions drivers/include/at25xxx/mtd.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
* directory for more details.
*/

#ifndef AT25XXX_MTD_H
#define AT25XXX_MTD_H

/**
* @defgroup drivers_mtd_at25xxx MTD wrapper for AT25xxx family of SPI-EEPROMs
* @ingroup drivers_storage
Expand All @@ -19,9 +22,6 @@
* @author Johannes Koster <johannes.koster@ml-pa.com>
*/

#ifndef AT25XXX_MTD_H
#define AT25XXX_MTD_H

#include <stdint.h>

#include "at25xxx.h"
Expand Down Expand Up @@ -52,5 +52,5 @@ extern const mtd_desc_t mtd_at25xxx_driver;
}
#endif

#endif /* AT25XXX_MTD_H */
/** @} */
#endif /* AT25XXX_MTD_H */
8 changes: 4 additions & 4 deletions drivers/include/at30tse75x.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
* directory for more details.
*/

#ifndef AT30TSE75X_H
#define AT30TSE75X_H

/**
* @defgroup drivers_at30tse75x AT30TSE75x temperature sensor with EEPROM
* @ingroup drivers_sensors
Expand All @@ -22,9 +25,6 @@
* @author Daniel Krebs <github@daniel-krebs.net>
*/

#ifndef AT30TSE75X_H
#define AT30TSE75X_H

#include <stdint.h>
#include "periph/i2c.h"

Expand Down Expand Up @@ -300,5 +300,5 @@ int at30tse75x_get_temperature(const at30tse75x_t* dev, float* temperature);
}
#endif

#endif /* AT30TSE75X_H */
/** @} */
#endif /* AT30TSE75X_H */
Loading
0