Diff: Components/hts221/hts221_class.h

Revision:

54:2a676c734b30

Parent:

50:f507d4465c31

Child:

57:04563dd74269

diff -r 54553fd15b50 -r 2a676c734b30 Components/hts221/hts221_class.h
--- a/Components/hts221/hts221_class.h	Wed Jun 10 16:44:54 2015 +0200
+++ b/Components/hts221/hts221_class.h	Wed Jun 10 18:03:42 2015 +0200
@@ -51,7 +51,7 @@
 class HTS221 : public HumiditySensor, public TempSensor {
  public:
 	/** Constructor
-	 * @param i2c device I2C to be used for communication
+	 * @param[in] i2c device I2C to be used for communication
 	 */
         HTS221(DevI2C &i2c) : HumiditySensor(), TempSensor(), dev_i2c(i2c) {
 		T0_degC = T1_degC = H0_rh = H1_rh = 0.0;
@@ -109,8 +109,6 @@
 
 	/**
 	 * @brief  Configures HTS221 interrupt lines for NUCLEO boards
-	 * @param  None
-	 * @retval None
 	 */
 	void HTS221_IO_ITConfig(void)
 	{
@@ -119,7 +117,6 @@
 
 	/**
 	 * @brief  Configures HTS221 I2C interface
-	 * @param  None
 	 * @retval HUM_TEMP_OK in case of success, an error code otherwise
 	 */
 	HUM_TEMP_StatusTypeDef HTS221_IO_Init(void)
@@ -128,11 +125,12 @@
 	}
 
 	/**
-	 * @brief utility function to read data from STC3115
-	 * @param  pBuffer: pointer to data to be read.
-	 * @param  RegisterAddr: specifies internal address register to read from.
-	 * @param  NumByteToRead: number of bytes to be read.
-	 * @retval HUM_TEMP_OK if ok, HUM_TEMP_ERROR if an I2C error has occured
+	 * @brief  Utility function to read data from HTS221
+	 * @param  pBuffer pointer to the byte-array to read data in to
+	 * @param  RegisterAddr specifies internal address register to read from.
+	 * @param  NumByteToRead number of bytes to be read.
+	 * @retval HUM_TEMP_OK if ok, 
+	 * @retval HUM_TEMP_ERROR if an I2C error has occured
 	 */
 	HUM_TEMP_StatusTypeDef HTS221_IO_Read(uint8_t* pBuffer, 
 					      uint8_t RegisterAddr, uint16_t NumByteToRead)
@@ -148,11 +146,12 @@
 	}
 	
 	/**
-	 * @brief utility function to write data to STC3115
-	 * @param  pBuffer: pointer to buffer to be filled.
-	 * @param  RegisterAddr: specifies internal address register to read from.
-	 * @param  NumByteToWrite: number of bytes to write.
-	 * @retval 0 if ok, -1 if an I2C error has occured
+	 * @brief  Utility function to write data to HTS221
+	 * @param  pBuffer pointer to the byte-array data to send
+	 * @param  RegisterAddr specifies internal address register to read from.
+	 * @param  NumByteToWrite number of bytes to write.
+	 * @retval HUM_TEMP_OK if ok, 
+	 * @retval HUM_TEMP_ERROR if an I2C error has occured
 	 */
 	HUM_TEMP_StatusTypeDef HTS221_IO_Write(uint8_t* pBuffer, 
 					       uint8_t RegisterAddr, uint16_t NumByteToWrite)