DOCS: Add comments to exported functions

event/event.go

@@ -24,6 +24,7 @@ type Event struct {
 	IsDir bool
 }
 
+// New creates and returns a new event struct
 func New(file, path, dest, ext string) *Event {
 	return &Event{
 		File:        file,
@@ -50,6 +51,7 @@ func (e *Event) IsValidEvent(ext string) bool {
 	return false
 }
 
+// IsNewDirEvent returns a bool if the given path is a directory or not
 func (e *Event) IsNewDirEvent() bool {
 	if e.Ext == "" && utils.ValidatePath(e.Path) {
 		return true

utils/utils.go

@@ -33,6 +33,10 @@ func ValidateFileExt(ext string) bool {
 	return true
 }
 
+// ScanFilesInDir scans and returns a map of all files in a given directory.
+// The returned map is a key value of the filename, and if a directory.
+// im_a_dir -> true
+// sample.txt -> false
 func ScanFilesInDir(path string) (map[string]bool, error) {
 	files, err := ioutil.ReadDir(path)
 	if err != nil {