Diff: Debug.h

Revision:

15:a9db6d4c2a8f

Parent:

14:5a3b0cabbcd4

Child:

16:e232e16e4f46

--- a/Debug.h	Thu Apr 18 10:23:17 2019 +0000
+++ b/Debug.h	Thu Apr 18 10:41:55 2019 +0000
@@ -25,16 +25,11 @@
 
 
 /** Debug_complete class.
- *  Used for printing complete configuration of peripherals
- *
- * Example:
+ *  Class for stepping programme and printing actual position and complete configuration of certain peripherals.
+ *  Functions printf, putc and getc are also defined in the class.
+ * Example program:
  * @code
  * // ----------------------------------------------------------------------------
- * // "THE BEER-WARE LICENSE" (Revision 42):
- * // <phk@FreeBSD.ORG> wrote this file. As long as you retain this notice you
- * // can do whatever you want with this stuff. If we meet some day, and you think
- * // this stuff is worth it, you can buy me a beer in return Poul-Henning Kamp
- * // ----------------------------------------------------------------------------
  * // Author: Lukas Bielesch 
  * // Department of Measurement, Czech technical university in Prague, Czech Republic 
  * // Date of publication: 15. Apr 2019
@@ -129,16 +124,12 @@
 };
 
 /** Debug_serial class.
- *  Used for printing for actual position of running program and one variable
+ *  Class for stepping and printing for actual position of the running programme with optional print of one variable (int, float, char or char*).
+ *  Functions printf, putc and getc are also defined in the class.
  *
- * Example:
+ * Example program:
  * @code
  * // ----------------------------------------------------------------------------
- * // "THE BEER-WARE LICENSE" (Revision 42):
- * // <phk@FreeBSD.ORG> wrote this file. As long as you retain this notice you
- * // can do whatever you want with this stuff. If we meet some day, and you think
- * // this stuff is worth it, you can buy me a beer in return Poul-Henning Kamp
- * // ----------------------------------------------------------------------------
  * // Author: Lukas Bielesch 
  * // Department of Measurement, Czech technical university in Prague, Czech Republic 
  * // Date of publication: 15. Apr 2019
@@ -147,7 +138,7 @@
  * AnalogIn analog(PA_5);
  * PwmOut pwm(PA_6);
  * DigitalOut out(PA_4);
- * Debug_serial pc(PA_2, PA_3, 115200);
+ * Debug_serial pc(PA_2, PA_3, 115200); //
  * 
  * int main(){
  *     int var = 0;
@@ -255,16 +246,11 @@
 
 
 /** Debug_led class.
- *  Used for stepping the program
+ *  Class for stepping the program with debug LED and button, that is connected to GND(default) or VCC.
  *
- * Example:
+ * Example program:
  * @code
  * // ----------------------------------------------------------------------------
- * // "THE BEER-WARE LICENSE" (Revision 42):
- * // <phk@FreeBSD.ORG> wrote this file. As long as you retain this notice you
- * // can do whatever you want with this stuff. If we meet some day, and you think
- * // this stuff is worth it, you can buy me a beer in return Poul-Henning Kamp
- * // ----------------------------------------------------------------------------
  * // Author: Lukas Bielesch 
  * // Department of Measurement, Czech technical university in Prague, Czech Republic 
  * // Date of publication: 15. Apr 2019
@@ -273,8 +259,7 @@
  * AnalogIn analog(PA_5);
  * PwmOut pwm(PA_6);
  * DigitalOut out(PA_4);
- * 
- * Debug_led deb(PA_5, PA_6, "BUTTON_VDD");
+ * Debug_led deb(PA_5, PA_6, "BUTTON_VDD"); //debug led on PA5, debug button connected to VDD on PA6
  * int main(){
  * 
  *     out = 1;