Revision 3:0aa2cdeb2e2b, committed 2013-12-10

Comitter:

xeta05

Date:

Tue Dec 10 11:17:13 2013 +0000

Parent:

2:ccc9acaebd38

Commit message:

docs updated

Changed in this revision

diff -r ccc9acaebd38 -r 0aa2cdeb2e2b DRV8833.cpp
--- a/DRV8833.cpp	Mon Dec 02 08:02:08 2013 +0000
+++ b/DRV8833.cpp	Tue Dec 10 11:17:13 2013 +0000
@@ -1,16 +1,39 @@
-/* mbed simple DRV8833 H-bridge motor controller
+/* 
+ * @file DRV8833.h
+ * @author Oskar Lopez de Gamboa
+ *
+ * @section LICENSE
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute,
+ * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
+ * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * @section DESCRIPTION
+ *
+ * mbed simple DRV8833 H-bridge motor controller
  * 
  *
  * PWM a un puente en H(DRV8833) conectado a los motores.
- * El comportamiento del driver es el siguiente
+ * El comportamiento del driver es el siguiente:
  *  
  *          x_PWM1 x_PWM2    Mode
  *            0      0       Coast/Fast decay
  *            0      1       Reverse
  *            1      0       Forward
  *            1      1       Brake/slow decay
- *15/10/2013
-**/
+ *10/12/2013
+*/
 
 
 #include "DRV8833.h"

diff -r ccc9acaebd38 -r 0aa2cdeb2e2b DRV8833.h
--- a/DRV8833.h	Mon Dec 02 08:02:08 2013 +0000
+++ b/DRV8833.h	Tue Dec 10 11:17:13 2013 +0000
@@ -1,4 +1,27 @@
-/* mbed simple DRV8833 H-bridge motor controller
+/* 
+ * @file DRV8833.h
+ * @author Oskar Lopez de Gamboa
+ *
+ * @section LICENSE
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute,
+ * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
+ * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * @section DESCRIPTION
+ *
+ * mbed simple DRV8833 H-bridge motor controller
  * 
  *
  * PWM a un puente en H(DRV8833) conectado a los motores.
@@ -9,9 +32,8 @@
  *            0      1       Reverse
  *            1      0       Forward
  *            1      1       Brake/slow decay
- *15/10/2013
+ *10/12/2013
 */
-
 #ifndef MBED_DRV8833
 #define MBED_DRV8833
 
@@ -52,9 +74,8 @@
     /** Brake the H-bridge coast or brake.
      * 
      * Defaults to coast.
-     *
-     * Coast => pwm1 = pwm2 = 0
-     * Brake => pwm1 = pwm2 = 1
+     * @param mode - Braking mode.COAST(default)or BRAKE. 
+     * 
      */
     void brake(int mode = COAST);