From 5cb2bd220e963f3d6fc23503e57e26d18047c174 Mon Sep 17 00:00:00 2001
From: Brendan Le Foll <brendan.le.foll@intel.com>
Date: Wed, 7 Sep 2016 13:27:07 +0100
Subject: [PATCH] spi.hpp: Add documentation to raw mode constructor

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
---
 api/mraa/spi.hpp | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/api/mraa/spi.hpp b/api/mraa/spi.hpp
index 94a3f64..f82aa95 100644
--- a/api/mraa/spi.hpp
+++ b/api/mraa/spi.hpp
@@ -70,6 +70,12 @@ class Spi
         }
     }
 
+    /**
+     * Initialise SPI object using 'raw' mode. Mraa will go and grab the spidev device lablled /dev/spidev<bus>.<cs>
+     *
+     * @param bus to use
+     * @param cs to use
+     */
     Spi(int bus, int cs)
     {
         m_spi = mraa_spi_init_raw(bus, cs);