Diff: FakeSensor/FakeBarometer.cpp

Revision:

83:0d3572a8a851

Parent:

50:c07e968b9582

Child:

85:422d0a1b95cf

--- a/FakeSensor/FakeBarometer.cpp	Thu May 11 15:53:15 2017 +0000
+++ b/FakeSensor/FakeBarometer.cpp	Thu May 11 19:23:55 2017 +0000
@@ -1,9 +1,12 @@
 #include "FakeSensor.h"
 #include "mbed.h"
 
-/*
+/**
     Constructor
     Takes in minimum and maximum values for fake pressure readings
+    
+    @param pressMin :   Minimum value for pressure.
+    @param pressMax :   Maximum value for pressure.
 */
 FakeBarometer::FakeBarometer(float pressMin, float pressMax)
 {
@@ -11,14 +14,15 @@
     pressureMax = pressMax;
 }
 
-/*
-    Simply fakes a get call to the sensor by doing nothing
+/**
+    Fakes a get call to the sensor by doing nothing.
 */
 void FakeBarometer::get() {}
 
-/*
+/**
     Generates a random number for pressure using the range given in the constructor
-    Returns the random number generated
+    
+    @return actual :    The random number generated, simulating pressure.
 */
 float FakeBarometer::pressure()
 {