From fef0be8c4ca32f07270b49d11f3894d0f0777c32 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Joakim=20Nohlg=C3=A5rd?= <joakim.nohlgard@eistec.se>
Date: Sat, 28 Apr 2018 15:37:41 +0200
Subject: [PATCH] pulse_counter: Editorial changes to docs
---
drivers/include/pulse_counter.h | 17 ++++++++---------
1 file changed, 8 insertions(+), 9 deletions(-)
diff --git a/drivers/include/pulse_counter.h b/drivers/include/pulse_counter.h
index e81c876b35..5e69cf8d43 100644
--- a/drivers/include/pulse_counter.h
+++ b/drivers/include/pulse_counter.h
@@ -7,16 +7,15 @@
*/
/**
- * @defgroup drivers_pulse_counter extra sensor
+ * @defgroup drivers_pulse_counter Pulse counter
* @ingroup drivers_sensors
*
- * The connection between the MCU and the PULSE_COUNTER is based on the
- * GPIO-interface.
+ * @brief GPIO based pulse counting driver
*
* @{
*
* @file
- * @brief Driver for the PULSE_COUNTER extra sensor
+ * @brief Driver for the pulse counter
*
* @author Hyung-Sin Kim <hs.kim@cs.berkeley.edu>
*/
@@ -40,14 +39,14 @@ typedef struct {
} pulse_counter_params_t;
/**
- * @brief Device descriptor for a PULSE_COUNTER device
+ * @brief Device descriptor for a pulse counter device
*/
typedef struct {
int16_t pulse_count; /**< pulse counter */
} pulse_counter_t;
/**
- * @brief Initialize an PULSE_COUNTER device
+ * @brief Initialize a pulse counter device
*
* @param[out] dev device descriptor
* @param[in] params configuration parameters
@@ -58,7 +57,7 @@ typedef struct {
int pulse_counter_init(pulse_counter_t *dev, const pulse_counter_params_t *params);
/**
- * @brief Read and reset PULSE_COUNTER value
+ * @brief Read and reset pulse counter value
*
* @param[in] dev device descriptor of sensor
*
@@ -67,7 +66,7 @@ int pulse_counter_init(pulse_counter_t *dev, const pulse_counter_params_t *param
int16_t pulse_counter_read_with_reset(const void *dev);
/**
- * @brief Read PULSE_COUNTER value
+ * @brief Read pulse counter value
*
* @param[in] dev device descriptor of sensor
*
@@ -76,7 +75,7 @@ int16_t pulse_counter_read_with_reset(const void *dev);
int16_t pulse_counter_read_without_reset(const void *dev);
/**
- * @brief Reset PULSE_COUNTER value
+ * @brief Reset pulse counter value
*
* @param[in] dev device descriptor of sensor
*/
--
GitLab