Revision 4:f7af875abe50, committed 2020-10-26

Comitter:

cnckiwi31

Date:

Mon Oct 26 08:27:12 2020 +0000

Parent:

3:22f8cfcad8d6

Commit message:

Prepared for documentation with copyright boilerplate added

Changed in this revision

--- a/lcm101.h	Fri Oct 12 12:09:59 2018 +0000
+++ b/lcm101.h	Mon Oct 26 08:27:12 2020 +0000
@@ -1,19 +1,34 @@
+/*  Copyright 2017 Martijn Grootens
+ 
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+ 
+        http://www.apache.org/licenses/LICENSE-2.0
+ 
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+*/
+
 #ifndef _LCM101_H_
 #define _LCM101_H_
 
 #include "mbed.h"
 
 /**
- * Simple class to read out an LCM101 S-beam force sensor connected to an analog
+ * Simple class to read out an Omega LCM101 S-beam force sensor connected to an analog
  * input.
  */
 class Lcm101 {
 public:
 
-    /**
-     * @param pin_a_in PinName of analog input
-     * @param offset of analog value (calibration data)
-     * @param factor multiplication factor for analog value (calibration data)
+    /** constructor
+     * @param pin_a_in: PinName of analog input
+     * @param offset: linear scaling offset for analog value read from sensor(calibration data)
+     * @param factor: multiplication factor for analog value read from sensor(calibration data)
      */
     Lcm101(PinName pin_a_in, float offset, float factor) :
         analog_in_(pin_a_in),
@@ -50,7 +65,7 @@
     }
     
     /**
-     * @return ffset of analog value
+     * @return offset of analog value
      */
     float get_offset() { return kOffset_; }