Diff: Debug.h

Revision:

25:807b447e4995

Parent:

24:bc7c4e8f3fe0

Child:

26:541255b7c539

--- a/Debug.h	Mon May 27 00:15:37 2019 +0000
+++ b/Debug.h	Mon May 27 00:23:26 2019 +0000
@@ -38,9 +38,8 @@
 
 
 /** Debug_complete class.
- *  Class for stepping programme and printing actual position and complete configuration of certain peripherals.
+ *  Class for stepping program, printing actual position and complete configuration of certain peripherals.
  *
- *  Functions printf, putc and getc are also defined in the class.
  *
  * Example program:
  * @code
@@ -74,14 +73,16 @@
 public:
 
     /** Create object of class Debug_complete
-     * @param tx_pin TX pin of serial port of the board
-     * @param rx_pin RX pin of serial port of the board
-     * @param baudrate desired baudrate value of serial port
+     * @param tx_pin TX pin of debug serial port of the board
+     * @param rx_pin RX pin of debug serial port of the board
+     * @param baudrate desired baudrate value of serial port, default value is 115200 Bd/s
      */
     Debug_complete(PinName tx_pin, PinName rx_pin, int baudrate = 115200);
      
     /** Perform one breakpoint
-     * @param line_number line number of the breakpoint
+     * function stops the program and shows configuration of certain peripherals,  
+     * then it waits until any character is received from PC and program continues
+     * @param line_number line number of the breakpoint, __LINE__ is recommended to use
      */ 
     void breakpoint(int line_number = -1);