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

@@ -33,6 +33,12 @@ namespace upm
     {
     public:
         virtual ~iCollision() {}
+
+        /**
+         * Returns if there's a collision
+         * 
+         * @return collision state
+         */
         virtual bool isColliding() = 0;
     };
 }

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

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;
   };
 }

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;
   };
 }

include/interfaces/iLight.hpp

@@ -33,6 +33,12 @@ namespace upm
     {
     public:
         virtual ~iLight() {}
+
+        /**
+         * Get luminance
+         * 
+         * @return Luminance value
+         */
         virtual float getLuminance() = 0;
     };
 }

include/interfaces/iMoisture.hpp

@@ -33,6 +33,12 @@ namespace upm
   {
   public:
     virtual ~iMoisture() {}
+
+    /**
+     * Measures moisture
+     * 
+     * @return moisture level
+     */
     virtual int getMoisture() = 0;
   };
 }

include/interfaces/iMotion.hpp

@@ -33,6 +33,12 @@ namespace upm
   {
   public:
     virtual ~iMotion() {}
+
+    /**
+     * Detects motion
+     * 
+     * @return true if motion detected
+     */
     virtual bool motionDetected() = 0;
   };
 }

include/interfaces/iPressure.hpp

@@ -36,6 +36,12 @@ namespace upm
   {
   public:
     virtual ~iPressure() {}
+
+    /**
+     * Measures applied pressure
+     * 
+     * @return gets pressure value
+     */
     virtual float getPressure() = 0;
 
     /**

include/interfaces/iTemperature.hpp

@@ -38,6 +38,12 @@ namespace upm
   public:
 
     virtual ~iTemperature() {}
+
+    /**
+     * Measures temperature
+     * 
+     * @return temperature value
+     */
     virtual float getTemperature() = 0;
 
     /**