improve godoc

cmd/root.go

@@ -1,3 +1,4 @@
+// Package cmd provides Command Line Interface support
 package cmd
 
 import (

logger/logger.go

@@ -5,7 +5,7 @@
 // The package provides a request logger to log the HTTP requests for REST API too.
 // The request logger uses chi.middleware.RequestLogger,
 // chi.middleware.LogFormatter and chi.middleware.LogEntry to build a structured
-// logger using zerlog
+// logger using zerolog
 package logger
 
 import (

metrics/metrics.go

@@ -1,3 +1,4 @@
+// Package metrics provides Prometheus metrics support
 package metrics
 
 import (

service/service.go

@@ -1,3 +1,4 @@
+// Package service allows to start and stop the SFTPGo service
 package service
 
 import (
@@ -83,7 +84,7 @@ func (s *Service) Wait() {
 	<-s.Shutdown
 }
 
-// Stop terminates the service and unblocks the Wait method
+// Stop terminates the service unblocking the Wait method
 func (s *Service) Stop() {
 	close(s.Shutdown)
 	logger.Debug(logSender, "", "Service stopped")