beenull/sftpgo-mirror
1
0
Fork 0
mirror of https://github.com/drakkan/sftpgo.git synced 2024-11-21 23:20:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

improve godoc

Browse source
This commit is contained in:
Nicola Murino 2019-10-08 10:29:16 +02:00
parent 60d4a3e1b5
commit 5ffa34dacb
4 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
cmd/root.go
View file

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

2
logger/logger.go
View file

@ -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 (

1
metrics/metrics.go
View file

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

3
service/service.go
View file

@ -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")