alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-02 01:41:12 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: updated @param tags, added missing function descriptions, other minor changes

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2017-04-10 16:59:39 -07:00
parent 39df7fd10f
commit 3aef2ea70e
94 changed files with 327 additions and 222 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/bmp280/bme280.hpp
View File

@ -75,7 +75,7 @@ namespace upm {
* operating mode is I2C.
*
* @param bus I2C or SPI bus to use.
* @param address The I2C address for this device. Use -1 for SPI.
* @param addr The I2C address for this device. Use -1 for SPI.
* @param cs The gpio pin to use for the SPI Chip Select. Use -1
* for I2C, or for SPI with a hardware controlled pin.
* @throws std::runtime_error on failure.
@ -104,7 +104,7 @@ namespace upm {
* suitable value by using one of the predefined modes for
* setUsageMode().
*
* @param mode One of the OSRS_H_T values.
* @param rate One of the OSRS_H_T values.
*/
void setOversampleRateHumidity(BME280_OSRS_H_T rate);

10
src/bmp280/bmp280.h
View File

@ -236,7 +236,7 @@ extern "C" {
* bmp280_set_usage_mode().
*
* @param dev Device context.
* @param mode One of the BMP280_OSRS_T_T values.
* @param rate One of the BMP280_OSRS_T_T values.
*/
void bmp280_set_oversample_rate_temperature(const bmp280_context dev,
BMP280_OSRS_T_T rate);
@ -248,7 +248,7 @@ extern "C" {
* bmp280_set_usage_mode().
*
* @param dev Device context.
* @param mode One of the BMP280_OSRS_P_T values.
* @param rate One of the BMP280_OSRS_P_T values.
*/
void bmp280_set_oversample_rate_pressure(const bmp280_context dev,
BMP280_OSRS_P_T rate);
@ -260,7 +260,7 @@ extern "C" {
* predefined modes for bmp280_set_usage_mode().
*
* @param dev Device context.
* @param mode One of the BME280_OSRS_H_T values.
* @param rate One of the BME280_OSRS_H_T values.
*/
void bmp280_set_oversample_rate_humidity(const bmp280_context dev,
BME280_OSRS_H_T rate);
@ -271,7 +271,7 @@ extern "C" {
* performing a measurement. See the data sheet for details.
*
* @param dev Device context.
* @param mode One of the BMP280_T_SB_T values.
* @param tsb One of the BMP280_T_SB_T values.
*/
void bmp280_set_timer_standby(const bmp280_context dev,
BMP280_T_SB_T tsb);
@ -283,7 +283,7 @@ extern "C" {
* bmp280_set_usage_mode().
*
* @param dev Device context.
* @param mode One of the BMP280_FILTER_T values.
* @param filter One of the BMP280_FILTER_T values.
*/
void bmp280_set_filter(const bmp280_context dev, BMP280_FILTER_T filter);

10
src/bmp280/bmp280.hpp
View File

@ -85,7 +85,7 @@ namespace upm {
* operating mode is I2C.
*
* @param bus I2C or SPI bus to use.
* @param address The I2C address for this device. Use -1 for SPI.
* @param addr The I2C address for this device. Use -1 for SPI.
* @param cs The gpio pin to use for the SPI Chip Select. Use -1
* for I2C, or for SPI with a hardware controlled pin.
* @throws std::runtime_error on failure.
@ -174,7 +174,7 @@ namespace upm {
* a suitable value by using one of the predefined modes for
* setUsageMode().
*
* @param mode One of the BMP280_OSRS_T_T values.
* @param rate One of the BMP280_OSRS_T_T values.
*/
void setOversampleRateTemperature(BMP280_OSRS_T_T rate);
@ -184,7 +184,7 @@ namespace upm {
* a suitable value by using one of the predefined modes for
* setUsageMode().
*
* @param mode One of the BMP280_OSRS_P_T values.
* @param rate One of the BMP280_OSRS_P_T values.
*/
void setOversampleRatePressure(BMP280_OSRS_P_T rate);
@ -193,7 +193,7 @@ namespace upm {
* this timer governs how long the chip will wait before
* performing a measurement. See the data sheet for details.
*
* @param mode One of the BMP280_T_SB_T values.
* @param tsb One of the BMP280_T_SB_T values.
*/
void setTimerStandby(BMP280_T_SB_T tsb);
@ -202,7 +202,7 @@ namespace upm {
* details. This value can be automatically set to a suitable
* value by using one of the predefined modes for setUsageMode().
*
* @param mode One of the BMP280_FILTER_T values.
* @param filter One of the BMP280_FILTER_T values.
*/
void setFilter(BMP280_FILTER_T filter);