SkyTEM BMAG / Mbed 2 deprecated BMAGThrRev

Bmag incl gps rettelse

Dependencies:   mbed WDT MODSERIAL BME280

Diff: BMAG/BMAG.h

Revision:
14:400ecb93c6a2
Parent:
11:d3d26d0e71ea
Child:
55:06c5f76e1a8c
--- a/BMAG/BMAG.h	Fri Apr 07 08:28:28 2017 +0000
+++ b/BMAG/BMAG.h	Tue Apr 11 09:49:06 2017 +0000
@@ -5,10 +5,20 @@
 
 using std::string;
 
+
+//! A BMAG string handling class
+/*!
+    This class is used to handle / parse the default data logging string
+    sent via rs232 to an external device from a GSM-19T magnetometer unit.
+    Methods of this class parse the received rs232 string and convert them into
+    individual data strings. (magTime, magnTMeasurement, and magMeasurementQuality)
+*/
+
 class BMAG{
     
 public:
-    //constructor
+    
+    //! The default constructor. No arguments are needed for this class ever.
     BMAG();
 
     //string parser