RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

Merge pull request #9047 from gebart/pr/pulse-counter-doxygen

Browse Source 
pulse_counter: Editorial changes to docs
This commit is contained in:
Alexandre Abadie 2018-04-28 18:43:26 +02:00 committed by GitHub
commit b81d6fada2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
drivers/include/pulse_counter.h
View File

@ -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
*/