motor control
Fork of X_NUCLEO_IHM01A1 by
Diff: Components/Interfaces/Component_class.h
- Revision:
- 22:ed3a6990a6eb
- Parent:
- 20:a8e81b65f0af
--- a/Components/Interfaces/Component_class.h Tue Jan 19 15:57:24 2016 +0000 +++ b/Components/Interfaces/Component_class.h Tue Feb 09 10:53:31 2016 +0000 @@ -1,7 +1,7 @@ /** ****************************************************************************** * @file Component_class.h - * @author Davide Aliprandi, STMicroelectronics + * @author AST * @version V1.0.0 * @date April 13th, 2015 * @brief This file contains the abstract class describing the interface of a @@ -37,7 +37,7 @@ */ -/* Define to prevent from recursive inclusion --------------------------------*/ +/* Define to prevent recursive inclusion -------------------------------------*/ #ifndef __COMPONENT_CLASS_H #define __COMPONENT_CLASS_H @@ -56,20 +56,20 @@ { public: /** - * @brief Initializing the component. - * @param init Pointer to device specific initalization structure. - * @retval "0" in case of success, an error code otherwise. + * @brief Initializing the component. + * @param[in] init pointer to device specific initalization structure. + * @retval "0" in case of success, an error code otherwise. */ virtual int Init(void *init) = 0; /** - * @brief Getting the ID of the component. - * @param id Pointer to an allocated variable to store the ID into. - * @retval "0" in case of success, an error code otherwise. + * @brief Getting the ID of the component. + * @param[out] id pointer to an allocated variable to store the ID into. + * @retval "0" in case of success, an error code otherwise. */ virtual int ReadID(uint8_t *id) = 0; }; #endif /* __COMPONENT_CLASS_H */ -/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ +/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/