spi.h: add doc to make sure people free the returned buffer after maa_spi_write
authorBrendan Le Foll <brendan.le.foll@intel.com>
Fri, 13 Jun 2014 16:52:59 +0000 (17:52 +0100)
committerBrendan Le Foll <brendan.le.foll@intel.com>
Fri, 13 Jun 2014 16:52:59 +0000 (17:52 +0100)
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
api/maa/spi.h

index 84945f8..6700d74 100644 (file)
@@ -81,7 +81,8 @@ maa_result_t maa_spi_frequency(maa_spi_context dev, int hz);
  */
 uint8_t maa_spi_write(maa_spi_context dev, uint8_t data);
 
-/** Write Buffer of bytes to the SPI device.
+/** Write Buffer of bytes to the SPI device. The pointer return has to be
+ * free'd by the caller.
  *
  * @param dev The Spi context
  * @param data to send