common: fix documentation string on mraa_init
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
@@ -48,7 +48,9 @@ typedef unsigned int mraa_boolean_t;
|
|||||||
*
|
*
|
||||||
* Detects running platform and attempts to use included pinmap, this is run on
|
* Detects running platform and attempts to use included pinmap, this is run on
|
||||||
* module/library init/load but is handy to rerun to check board initialised
|
* module/library init/load but is handy to rerun to check board initialised
|
||||||
* correctly. Anything but MRAA_SUCCESS should be considered a critical failure
|
* correctly. MRAA_SUCCESS inidicates correct (first time) initialisation
|
||||||
|
* whilst MRAA_ERROR_PLATFORM_ALREADY_INITIALISED indicates the board is
|
||||||
|
* already initialised correctly
|
||||||
*
|
*
|
||||||
* @return Result of operation
|
* @return Result of operation
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -44,7 +44,9 @@ namespace mraa {
|
|||||||
*
|
*
|
||||||
* Detects running platform and attempts to use included pinmap, this is run on
|
* Detects running platform and attempts to use included pinmap, this is run on
|
||||||
* module/library init/load but is handy to rerun to check board initialised
|
* module/library init/load but is handy to rerun to check board initialised
|
||||||
* correctly. Anything but MRAA_SUCCESS should be considered a critical failure
|
* correctly. MRAA_SUCCESS inidicates correct (first time) initialisation
|
||||||
|
* whilst MRAA_ERROR_PLATFORM_ALREADY_INITIALISED indicates the board is
|
||||||
|
* already initialised correctly
|
||||||
*
|
*
|
||||||
* @return Result of operation
|
* @return Result of operation
|
||||||
*/
|
*/
|
||||||
|
|||||||
Reference in New Issue
Block a user