Skip to content

Commit 1f61dd8

Browse files
authored
Some minor changes
1 parent 390cc31 commit 1f61dd8

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,31 +29,28 @@ If desired timestamps can be prefixed to the debug message. Timestamp output can
2929
Normally all debug output is redirected to the primary serial output of each board (`Serial`). In case you want to redirect the output to another output stream you can make use of `setDebugOutputStream(&Serial2)`.
3030

3131
# Documentation
32-
### 1. Debug :
33-
Arduino_DebugUtils Object that will be used for calling member functions.
32+
### 1. Debug :
33+
Arduino_DebugUtils Object that will be used for calling member functions.
3434

3535
### 2. Debug.setDebugLevel(int const debug_level) :
36-
Parameter debug_level in order of lowest to highest priority are : `DBG_NONE`, `DBG_ERROR`, `DBG_WARNING`, `DBG_INFO` (default), `DBG_DEBUG`, and `DBG_VERBOSE`.
37-
Return type: void.
36+
Parameter debug_level in order of lowest to highest priority are : `DBG_NONE`, `DBG_ERROR`, `DBG_WARNING`, `DBG_INFO` (default), `DBG_DEBUG`, and `DBG_VERBOSE`.
37+
Return type: void.
3838
Example:
3939
```
4040
Debug.setDebugLevel(DBG_VERBOSE);
4141
```
42-
43-
### 2. Debug.setDebugOutputStream(Stream * stream) :
42+
### 2. Debug.setDebugOutputStream(Stream * stream) :
4443
By default, Output Stream is Serial. In advanced cases other objects could be other serial ports (if available), or can be a Software Serial object.
4544
Example:
4645
```
4746
SoftwareSerial mySerial(10, 11); // RX, TX
48-
...
4947
Debug.setDebugOutputStream(&mySerial);
5048
```
51-
52-
### 3. Debug.timestampOn() :
49+
### 3. Debug.timestampOn() :
5350
Calling this function will switches on the timestamp in `Debug.print()` function call;
5451
By default, printing timestamp is off, unless turned on using this function call.
5552

56-
### 4. Debug.timestampOff() :
53+
### 4. Debug.timestampOff() :
5754
Calling this function will switches off the timestamp in `Debug.print()` function call;
5855

5956
### 5. Debug.print(int const debug_level, const char * fmt, ...);
@@ -63,5 +60,4 @@ Example:
6360
Debug.setDebugLevel(DBG_VERBOSE);
6461
int i = 0;
6562
Debug.print(DBG_VERBOSE, "DBG_VERBOSE i = %d", i);
66-
6763
```

0 commit comments

Comments
 (0)