Mirrors/sftpgo
1
0
Fork 0
mirror of https://github.com/drakkan/sftpgo.git synced 2025-12-08 07:10:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

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
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 package cmd
import ( 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 package provides a request logger to log the HTTP requests for REST API too.
// The request logger uses chi.middleware.RequestLogger, // The request logger uses chi.middleware.RequestLogger,
// chi.middleware.LogFormatter and chi.middleware.LogEntry to build a structured // chi.middleware.LogFormatter and chi.middleware.LogEntry to build a structured
// logger using zerlog // logger using zerolog
package logger package logger
import ( import (

1
metrics/metrics.go
View File

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

3
service/service.go
View File

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