Revision 2:5d6b80aeb455, committed 2020-10-26

Comitter:

cnckiwi31

Date:

Mon Oct 26 08:28:45 2020 +0000

Parent:

1:35bf896ac56e

Commit message:

Prepared for documentation with copyright boilerplate added

Changed in this revision

diff -r 35bf896ac56e -r 5d6b80aeb455 LinearActuator.h
--- a/LinearActuator.h	Wed Aug 12 10:02:19 2020 +0000
+++ b/LinearActuator.h	Mon Oct 26 08:28:45 2020 +0000
@@ -1,9 +1,24 @@
+/*  Copyright 2020 Allan Joshua Veale
+ 
+    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 _LINACT_H_
 #define _LINACT_H_
 
 #include "mbed.h"
 /**
- * Controlling aa linear actuator for moving the test rig joint up and down
+ * Controls a linear actuator for moving the test rig joint up and down
  */
 
 class LinearActuator
@@ -11,8 +26,8 @@
 public:
 
     /**
-     * @param dir_pin PinName of digital output controlling actuator direction (1 is retract, 0 is extend)
-     * @param pwm_pin PinName of digital pwm output controlling actuator speed
+     * @param dir_pin: PinName of digital output controlling actuator direction (1 is retract, 0 is extend)
+     * @param pwm_pin: PinName of digital pwm output controlling actuator speed
      */
     LinearActuator (PinName dir_pin, PinName pwm_pin) :
         DirPin(dir_pin),PwmPin(pwm_pin)