Revision 18:25dbc718084c, committed 2016-04-08

Comitter:

hemddabral

Date:

Fri Apr 08 09:22:36 2016 +0000

Parent:

17:cbdee5f7a2aa

Child:

19:af35fc938d88

Commit message:

updated doxygen style comments in Interfaces

Changed in this revision

--- a/Components/Interfaces/Instrumentation_amp_class.h	Fri Apr 08 08:59:17 2016 +0000
+++ b/Components/Interfaces/Instrumentation_amp_class.h	Fri Apr 08 09:22:36 2016 +0000
@@ -34,9 +34,9 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
  ******************************************************************************
- */
-
-
+ */
+
+
 /* Generated with STM32CubeTOO -----------------------------------------------*/
 
 
@@ -77,8 +77,18 @@
 	 *                                                                        *
 	 * Example:                                                               *
 	 *    virtual int GetValue(float *f) = 0;                                 *
-	 *------------------------------------------------------------------------*/
-	virtual unsigned int GetVoltage(void) = 0;
+	 *------------------------------------------------------------------------*/
+	 
+	/**
+	 * @brief  abstract method to obtain the amplified differential voltage in instrumentation Amplifier configuration
+	 * @retval amplified differential voltage in instrumentation Amplifier configuration
+	 */		 
+	virtual unsigned int GetVoltage(void) = 0;
+	
+	/**
+	 * @brief  abstract method to obtain the current consumed by the application in Current sensing configuration
+	 * @retval current consumed by the application in Current sensing configuration
+	 */		
 	virtual unsigned int GetCurrent(void) = 0;
 };
 

--- a/Components/Interfaces/Led_driver_class.h	Fri Apr 08 08:59:17 2016 +0000
+++ b/Components/Interfaces/Led_driver_class.h	Fri Apr 08 09:22:36 2016 +0000
@@ -34,9 +34,9 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
  ******************************************************************************
- */
-
-
+ */
+
+
 /* Generated with STM32CubeTOO -----------------------------------------------*/
 
 
@@ -77,7 +77,13 @@
 	 *                                                                        *
 	 * Example:                                                               *
 	 *    virtual int GetValue(float *f) = 0;                                 *
-	 *------------------------------------------------------------------------*/
+	 *------------------------------------------------------------------------*/
+	 
+	/**
+	 * @brief  abstract method for setting the duty cycle of LED in LED driver configuration
+ 	 * @param  dc duty cycle to set 
+	 * @retval duty cycle in LED driver configuration
+	 */		 
 	virtual int SetDutyCycle(float dc) = 0;
 };
 

--- 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;
 };
 

--- a/Components/Interfaces/Windcomp_class.h	Fri Apr 08 08:59:17 2016 +0000
+++ b/Components/Interfaces/Windcomp_class.h	Fri Apr 08 09:22:36 2016 +0000
@@ -78,7 +78,17 @@
 	 * Example:                                                               *
 	 *    virtual int GetValue(float *f) = 0;                                 *
 	 *------------------------------------------------------------------------*/
+	 
+	/**
+	 * @brief  abstract method for obtaining digital signal value 1 in windows comparator configuration
+	 * @retval digital signal value 1
+	 */			 
 	virtual unsigned int WindComp_Get_Signal1(void) = 0;
+	
+	/**
+	 * @brief  abstract method for obtaining digital signal value 2 in windows comparator configuration
+	 * @retval digital signal value 2
+	 */			
 	virtual unsigned int WindComp_Get_Signal2(void) = 0;};
 
 #endif /* __WINDCOMP_CLASS_H */

--- a/Components/tsu104/tsu104_class.h	Fri Apr 08 08:59:17 2016 +0000
+++ b/Components/tsu104/tsu104_class.h	Fri Apr 08 09:22:36 2016 +0000
@@ -125,9 +125,9 @@
 		return (int) TSU104_ReadID((uint8_t *) id);
 	}
 	/**
-	 * @brief  obtain digital value at arduino pin D2
-	 * @retval digital value at arduino pin D2
-	 */	
+	 * @brief  get digital signal value 1 in windows comparator configuration
+	 * @retval digital signal value 1
+	 */			
 	virtual unsigned int WindComp_Get_Signal1(void)
 	{
 		DigitalIn windowsCompD2(windCmp_signal_pin_1);
@@ -135,9 +135,9 @@
 	}
 
 	/**
-	 * @brief  obtain digital value at arduino pin D4
-	 * @retval digital value at arduino pin D4
-	 */		
+	 * @brief  get digital signal value 2 in windows comparator configuration
+	 * @retval digital signal value 2
+	 */			
 	virtual unsigned int WindComp_Get_Signal2(void)
 	{
 		DigitalIn windowsCompD4(windCmp_signal_pin_2);