Diff: Components/tsv734/tsv734_class.h

Revision:

13:9cecc8d66cc1

Parent:

7:c66b5473f3a1

Child:

14:8277ca0ab13a

--- a/Components/tsv734/tsv734_class.h	Thu Apr 07 04:15:34 2016 +0000
+++ b/Components/tsv734/tsv734_class.h	Thu Apr 07 07:51:13 2016 +0000
@@ -77,7 +77,7 @@
 /* Classes -------------------------------------------------------------------*/
 
 /**
- * @brief Class representing a TSV734 component.
+ * @brief Class representing a TSV734 operational amplifier component.
  */
 class TSV734 : public Led_driver
 {
@@ -108,36 +108,30 @@
 
 	/*** Public Component Related Methods ***/
 
-	/* ACTION 5 --------------------------------------------------------------*
-	 * Implement here the component's public methods, as wrappers of the C    *
-	 * component's functions.                                                 *
-	 * They should be:                                                        *
-	 *   + Methods with the same name of the C component's virtual table's    *
-	 *     functions (1);                                                     *
-	 *   + Methods with the same name of the C component's extended virtual   *
-	 *     table's functions, if any (2).                                     *
-	 *                                                                        *
-	 * Example:                                                               *
-	 *   virtual int GetValue(float *f)  //(1)                                *
-	 *   {                                                                    *
-	 *     return COMPONENT_GetValue(float *f);                               *
-	 *   }                                                                    *
-	 *                                                                        *
-	 *   virtual int EnableFeature(void) //(2)                                *
-	 *   {                                                                    *
-	 *     return COMPONENT_EnableFeature();                                  *
-	 *   }                                                                    *
-	 *------------------------------------------------------------------------*/
+	/**
+	 * @brief initialize the class for TSV734 operational amplifier component
+	 * @retval COMPONENT_OK if initialization is successfull
+	 * @retval suitable error code otherwise	 
+	 */	
 	virtual int Init(void *init = NULL)
 	{
 		return (int) TSV734_Init((void *) init);
 	}
 
+	/**
+	 * @brief  obtain component ID for TSV734 perational amplifier
+	 * @retval component ID for TSV734 operational amplifier
+	 */	
 	virtual int ReadID(uint8_t *id = NULL)
 	{
 		return (int) TSV734_ReadID((uint8_t *) id);
 	}
 	
+	/**
+	 * @brief  set the duty cycle of LED in LED driver configuration
+ 	 * @param  Configure the TSV734 operational amplifier in LED driver configuration
+	 * @retval 0 
+	 */		
 	virtual int Configure(PinName pinName, unsigned int period_us)
 	{
 		pwmPinName = pinName;
@@ -147,6 +141,11 @@
 		return 0;
 	}	
 
+	/**
+	 * @brief  set 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)
 	{
 		PwmOut ledOut(pwmPinName);