comments

internal/app/imageconvert/files.go

@@ -21,6 +21,7 @@ var ImageExtensionRegex = regexp.MustCompile(".*.jpg$|.*.jpeg$|.*.png$|.*.webp$|
 // RenameExtensionRegex captures file extensions that we would like to rename to the extensions above.
 var RenameSuffixRegex = regexp.MustCompile(".*.jpeg$|.*.png$|.*.webp$|.*.JPG$|.*.JPEG$|.*.PNG$|.*.WEBP$")
 
+// NilTime is 0
 var NilTime = time.Time{}
 
 // ParseSkipMap reads the log from the last time this was run and

internal/app/imageconvert/run.go

@@ -9,6 +9,7 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
+// Start begins the conversion process and returns counts of each type of operation preformed.
 func (ic *ImageConverter) Start(results chan ConversionResult) (int, int, int, int, map[string]int, error) {
 
 	var resultChans = make([]chan ConversionResult, ic.Threads)

internal/app/imageconvert/worker.go

@@ -10,6 +10,7 @@ import (
 	"github.com/kmulvey/path"
 )
 
+// ConversionResult is all the information about the image that was converted.
 type ConversionResult struct {
 	OriginalFileName  string
 	ConvertedFileName string