Luca Istorico / X_NUCLEO_IHM02A1

Library to handle the X_NUCLEO_IHM02A1 Motor Control Expansion Board based on the L6470 component.

Dependencies:   X_NUCLEO_COMMON

Fork of X_NUCLEO_IHM02A1 by ST

Diff: Components/Interfaces/Component_class.h

Revision:
1:b78dab6d2c58
Parent:
0:92706998571a
Child:
4:381d76f5b0b4
--- a/Components/Interfaces/Component_class.h	Fri Nov 20 18:07:45 2015 +0000
+++ b/Components/Interfaces/Component_class.h	Wed Nov 25 11:59:37 2015 +0000
@@ -56,16 +56,16 @@
 {
 public:
     /**
-     * @brief       Initialization of the component.
-     * @param[out]  ptr Pointer to device specific initalization structure.
-     * @return      0 in case of success, an error code otherwise.
+     * @brief  Initializing the component.
+     * @param  init Pointer to device specific initalization structure.
+     * @retval "0" in case of success, an error code otherwise.
      */
-    virtual int Init(void *ptr) = 0;
+    virtual int Init(void *init) = 0;
 
     /**
-     * @brief       Get ID of the component.
-     * @param[out]  id Pointer to where to store the ID to.
-     * @return      0 in case of success, an error code otherwise.
+     * @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.
      */
     virtual int ReadID(uint8_t *id) = 0;
 };