From c642e02a180c71bf746f2dc02a8496fdfec2e7f8 Mon Sep 17 00:00:00 2001
From: Serban Waltter <serban.waltter@rinftech.com>
Date: Wed, 27 Jun 2018 15:14:24 +0300
Subject: [PATCH] Added documentation to interfaces

Signed-off-by: Serban Waltter <serban.waltter@rinftech.com>
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
---
 include/interfaces/iCollision.hpp   | 6 ++++++
 include/interfaces/iDistance.hpp    | 6 ++++++
 include/interfaces/iHallEffect.hpp  | 6 ++++++
 include/interfaces/iHumidity.hpp    | 6 ++++++
 include/interfaces/iLight.hpp       | 6 ++++++
 include/interfaces/iMoisture.hpp    | 6 ++++++
 include/interfaces/iMotion.hpp      | 6 ++++++
 include/interfaces/iPressure.hpp    | 6 ++++++
 include/interfaces/iTemperature.hpp | 6 ++++++
 9 files changed, 54 insertions(+)

diff --git a/include/interfaces/iCollision.hpp b/include/interfaces/iCollision.hpp
index bc43c56d..79ea2671 100644
--- a/include/interfaces/iCollision.hpp
+++ b/include/interfaces/iCollision.hpp
@@ -33,6 +33,12 @@ namespace upm
     {
     public:
         virtual ~iCollision() {}
+
+        /**
+         * Returns if there's a collision
+         * 
+         * @return collision state
+         */
         virtual bool isColliding() = 0;
     };
 }
diff --git a/include/interfaces/iDistance.hpp b/include/interfaces/iDistance.hpp
index aac6da24..89bd7300 100644
--- a/include/interfaces/iDistance.hpp
+++ b/include/interfaces/iDistance.hpp
@@ -36,6 +36,12 @@ namespace upm
   {
   public:
     virtual ~iDistance() {}
+
+    /**
+     * Get distance from sensor
+     * 
+     * @return Returns the distance
+     */
     virtual float getDistance() = 0;
     /**
       * Convert distance value from Cm(default) to one
diff --git a/include/interfaces/iHallEffect.hpp b/include/interfaces/iHallEffect.hpp
index ee24369c..05b7528d 100644
--- a/include/interfaces/iHallEffect.hpp
+++ b/include/interfaces/iHallEffect.hpp
@@ -33,6 +33,12 @@ namespace upm
   {
   public:
     virtual ~iHallEffect() {}
+
+    /**
+     * Detects magnetic field
+     * 
+     * @return True if magenet detected
+     */
     virtual bool magnetDetected() = 0;
   };
 }
diff --git a/include/interfaces/iHumidity.hpp b/include/interfaces/iHumidity.hpp
index 8e35037d..da03113e 100644
--- a/include/interfaces/iHumidity.hpp
+++ b/include/interfaces/iHumidity.hpp
@@ -33,6 +33,12 @@ namespace upm
   {
   public:
     virtual ~iHumidity() {}
+
+    /**
+     * Measures humidity around the sensor
+     * 
+     * @return Gets the humidity value
+     */
     virtual float getHumidity() = 0;
   };
 }
diff --git a/include/interfaces/iLight.hpp b/include/interfaces/iLight.hpp
index 4c849694..94524b59 100644
--- a/include/interfaces/iLight.hpp
+++ b/include/interfaces/iLight.hpp
@@ -33,6 +33,12 @@ namespace upm
     {
     public:
         virtual ~iLight() {}
+
+        /**
+         * Get luminance
+         * 
+         * @return Luminance value
+         */
         virtual float getLuminance() = 0;
     };
 }
\ No newline at end of file
diff --git a/include/interfaces/iMoisture.hpp b/include/interfaces/iMoisture.hpp
index 6fd6890c..f03ca654 100644
--- a/include/interfaces/iMoisture.hpp
+++ b/include/interfaces/iMoisture.hpp
@@ -33,6 +33,12 @@ namespace upm
   {
   public:
     virtual ~iMoisture() {}
+
+    /**
+     * Measures moisture
+     * 
+     * @return moisture level
+     */
     virtual int getMoisture() = 0;
   };
 }
diff --git a/include/interfaces/iMotion.hpp b/include/interfaces/iMotion.hpp
index d38aa212..696f1209 100644
--- a/include/interfaces/iMotion.hpp
+++ b/include/interfaces/iMotion.hpp
@@ -33,6 +33,12 @@ namespace upm
   {
   public:
     virtual ~iMotion() {}
+
+    /**
+     * Detects motion
+     * 
+     * @return true if motion detected
+     */
     virtual bool motionDetected() = 0;
   };
 }
diff --git a/include/interfaces/iPressure.hpp b/include/interfaces/iPressure.hpp
index eedb6429..acf08eba 100644
--- a/include/interfaces/iPressure.hpp
+++ b/include/interfaces/iPressure.hpp
@@ -36,6 +36,12 @@ namespace upm
   {
   public:
     virtual ~iPressure() {}
+
+    /**
+     * Measures applied pressure
+     * 
+     * @return gets pressure value
+     */
     virtual float getPressure() = 0;
 
     /**
diff --git a/include/interfaces/iTemperature.hpp b/include/interfaces/iTemperature.hpp
index b90ca185..4001b575 100644
--- a/include/interfaces/iTemperature.hpp
+++ b/include/interfaces/iTemperature.hpp
@@ -38,6 +38,12 @@ namespace upm
   public:
 
     virtual ~iTemperature() {}
+
+    /**
+     * Measures temperature
+     * 
+     * @return temperature value
+     */
     virtual float getTemperature() = 0;
 
     /**