Added comments in winsize.go

Signed-off-by: xchenan <xchenan@gmail.com>
elves · May 22, 2017 · 6835461 · 6835461
1 parent 456db58
commit 6835461
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/sys/winsize.go b/sys/winsize.go
@@ -10,16 +10,19 @@ import (
 	"unsafe"
 )
 
-// GetWinsize queries the size of the terminal referenced by the given file
-// descriptor.
-//
+// winSize mirrors struct winsize in the C header.
+// The following declaration matches struct winsize in the headers of
+// Linux and FreeBSD.
 type winSize struct {
 	row    uint16
 	col    uint16
 	Xpixel uint16
 	Ypixel uint16
 }
 
+// GetWinsize queries the size of the terminal referenced by
+// the given file descriptor.
+
 func GetWinsize(fd int) (row, col int) {
 	ws := winSize{}
 	if err := ioctl(uintptr(fd), unix.TIOCGWINSZ, unsafe.Pointer(&ws)); err != nil {