Private
Public Access
2
0

common: fix documentation string on mraa_init

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Brendan Le Foll
2015-03-19 09:29:41 +00:00
parent 8b0b9f1a79
commit e03eec3ce1
2 changed files with 6 additions and 2 deletions

View File

@@ -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
*/ */

View File

@@ -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
*/ */