ST / X_NUCLEO_IKA01A1

mbed library for STMicroelectronics' X-NUCLEO-IKA01A1 expansion board.

Dependents:   HelloWorld_IKA01A1

Fork of X_NUCLEO_IKA01A1 by ST Expansion SW Team

Library for STMicroelectronics' X-NUCLEO-IKA01A1 multifunctional expansion board based on operational amplifiers.

Diff: Components/Interfaces/PhotoSensor_class.h

Revision:
18:25dbc718084c
Parent:
16:2f9443aedbe8
Child:
21:8d0624950dd1
--- a/Components/Interfaces/PhotoSensor_class.h	Fri Apr 08 08:59:17 2016 +0000
+++ b/Components/Interfaces/PhotoSensor_class.h	Fri Apr 08 09:22:36 2016 +0000
@@ -78,6 +78,12 @@
      * Example:                                                               *
      *    virtual int GetValue(float *f) = 0;                                 *
      *------------------------------------------------------------------------*/
+     
+    /**
+     * @brief  abstract method for obtaining the output voltage detected by photo sensor
+     * @param  pin AnalogIn pin to use for detecting the voltage
+     * @retval voltage detected by photo sensor
+     */          
     virtual unsigned int Get_PhotoSensor_GetVoltage(void) = 0;
 };