aio: Update documentation to mention 0 indexed

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
2017-06-06 15:56:14 +02:00
parent c36e4add5a
commit 4109b8b454
2 changed files with 6 additions and 2 deletions
--- a/api/mraa/aio.hpp
+++ b/api/mraa/aio.hpp
@@ -56,7 +56,9 @@ class Aio
    }
    /**
     * Aio Constructor, takes a pointer to the AIO context and initialises
-     * the AIO class
+     * the AIO class. Aio pins are always 0 indexed reguardless of their
+     * position. Check your board mapping for details. An arduino style layout
+     * will have A0 as pin14 but AIO0.
     *
     * @param void * to an AIO context
     */