Skip to content

Commit

Permalink
WIP: documentation change
Browse files Browse the repository at this point in the history
  • Loading branch information
xudongzheng committed Nov 4, 2023
1 parent 0d74655 commit 8febc48
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/machine/uart.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,12 @@ const (
// To implement the UART interface for a board, you must declare a concrete type as follows:
//
// type UART struct {
// Buffer *RingBuffer
// Buffer *RingBuffer
// rxCallback func(byte) bool
// }
//
// You can also add additional members to this struct depending on your implementation,
// but the *RingBuffer is required.
// Buffer and rxCallback are required.
// When you are declaring your UARTs for your board, make sure that you also declare the
// RingBuffer using the NewRingBuffer() function when you declare your UART:
//
Expand Down

0 comments on commit 8febc48

Please sign in to comment.