Diff: Debug.h

Revision:

21:60c8794c8472

Parent:

20:0227bb22d7ce

Child:

22:ac9b2cbb31a8

diff -r 0227bb22d7ce -r 60c8794c8472 Debug.h
--- a/Debug.h	Sat Mar 20 13:04:46 2021 +0000
+++ b/Debug.h	Sat Mar 20 13:11:44 2021 +0000
@@ -168,7 +168,7 @@
 //------------------------------------------------------------------------------------------------------------------
 
 /** Debug_led class.
- *  Class for stepping the program with debug LED and button, that is connected to GND(default) or VCC.\n
+ *  Class for stepping the program with debug LED and button, that is connected to GND(default) or VCC. External pull up/down resistor does not have to be used.\n
  *
  * Example program for STM32F042F6P6:
  * @code
@@ -214,11 +214,11 @@
     /** Create an object of Debug_led class
      * @param led_pin pin of of debug led
      * @param button_pin pin of of debug button
-     * @param mode mode of button connection(GND, VCC), default value value is GND
+     * @param mode mode of button connection(GND/VCC), default value value is GND
      */
     Debug_led(PinName led_pin, PinName button_pin, button_mode mode = GND);
     
-    /** Perform one breakpoint
+    /** Perform one breakpoint. At first, the program waits until the the button is released (from the previous breakpoint) and then it periodically flashes for number times with period of period_ms ms. When the button is pressed
      * @param number number of flashes of LED during the breakpoint, default value is 1
      * @param period_ms period of flashing of the LED in ms, default value is 300ms
      */