add doc string

gojekfarm · May 18, 2021 · 6b071c2 · 6b071c2
1 parent 76636d5
commit 6b071c2
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/component/http_server.go b/component/http_server.go
@@ -14,6 +14,7 @@ type HTTPServerOptions struct {
 	PreStop  func()
 }
 
+// HTTPServer is a helper which returns an xrun.ComponentFunc to start an http.Server
 func HTTPServer(opts HTTPServerOptions) xrun.ComponentFunc {
 	srv := opts.Server
 	ps := opts.PreStart