Antonio Maiorquim / Joystick_S_Controller

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   ST_INTERFACES X_NUCLEO_COMMON

Fork of X_NUCLEO_IHM01A1 by ST

Diff: Components/Interfaces/Component_class.h

Revision:
7:f7e0c3621f77
Parent:
0:2887415a46cd
Child:
9:6f116ce8e314
--- a/Components/Interfaces/Component_class.h	Thu Nov 19 10:56:34 2015 +0000
+++ b/Components/Interfaces/Component_class.h	Fri Nov 20 18:00:03 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;
 };