From 81c13171a985b89f2af6682dbd1d4b8766cb9af7 Mon Sep 17 00:00:00 2001 From: Jorin Vogel Date: Wed, 2 Aug 2017 14:25:05 +0200 Subject: Add some missing doc comments As pointed out by the linter, some exported functions and types are missing doc comments. The linter warnings have been reduced from 194 to 116. Not all missing comments have been added in this commit though. --- watcher/batcher.go | 3 +++ 1 file changed, 3 insertions(+) (limited to 'watcher') diff --git a/watcher/batcher.go b/watcher/batcher.go index 0b4083e81..6f4b276cf 100644 --- a/watcher/batcher.go +++ b/watcher/batcher.go @@ -19,6 +19,7 @@ import ( "github.com/fsnotify/fsnotify" ) +// Batcher batches file watch events in a given interval. type Batcher struct { *fsnotify.Watcher interval time.Duration @@ -27,6 +28,7 @@ type Batcher struct { Events chan []fsnotify.Event // Events are returned on this channel } +// New creates and starts a Batcher with the given time interval. func New(interval time.Duration) (*Batcher, error) { watcher, err := fsnotify.NewWatcher() @@ -64,6 +66,7 @@ OuterLoop: close(b.done) } +// Close stops the watching of the files. func (b *Batcher) Close() { b.done <- struct{}{} b.Watcher.Close() -- cgit v1.2.3