Added comment to Flush() for godoc

tarm · Mar 14, 2015 · f143639 · f143639
1 parent d30c3c8
commit f143639
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/serial_linux.go b/serial_linux.go
@@ -103,6 +103,8 @@ func (p *Port) Write(b []byte) (n int, err error) {
 	return p.f.Write(b)
 }
 
+// Discards data written to the port but not transmitted,
+// or data received but not read
 func (p *Port) Flush() error {
 	const TCFLSH = 0x540B
 	_, _, err := syscall.Syscall(

diff --git a/serial_posix.go b/serial_posix.go
@@ -133,6 +133,8 @@ func (p *Port) Write(b []byte) (n int, err error) {
 	return p.f.Write(b)
 }
 
+// Discards data written to the port but not transmitted,
+// or data received but not read
 func (p *Port) Flush() error {
 	_, err := C.tcflush(C.int(p.f.Fd()), C.TCIOFLUSH)
 	return err

diff --git a/serial_windows.go b/serial_windows.go
@@ -127,6 +127,8 @@ func (p *Port) Read(buf []byte) (int, error) {
 	return getOverlappedResult(p.fd, p.ro)
 }
 
+// Discards data written to the port but not transmitted,
+// or data received but not read
 func (p *Port) Flush() error {
 	return purgeComm(p.fd)
 }