util: recwatch: Improve godoc
This commit is contained in:
@@ -53,9 +53,15 @@ type Event struct {
|
|||||||
|
|
||||||
// RecWatcher is the struct for the recursive watcher. Run Init() on it.
|
// RecWatcher is the struct for the recursive watcher. Run Init() on it.
|
||||||
type RecWatcher struct {
|
type RecWatcher struct {
|
||||||
Path string // computed path
|
// Path is the computer path that we're watching.
|
||||||
Recurse bool // should we watch recursively?
|
Path string
|
||||||
Opts []Option // list of options we use
|
|
||||||
|
// Recurse specifies if we should watch recursively.
|
||||||
|
// TODO: Should this get converted into an Option?
|
||||||
|
Recurse bool
|
||||||
|
|
||||||
|
// Opts are the list of options that we are using this with.
|
||||||
|
Opts []Option
|
||||||
|
|
||||||
options *recwatchOptions // computed options
|
options *recwatchOptions // computed options
|
||||||
isDir bool // computed isDir
|
isDir bool // computed isDir
|
||||||
|
|||||||
Reference in New Issue
Block a user