Add doc comment.

Jigsaw-Code · Jun 14, 2024 · 7212265 · 7212265
1 parent 1952036
commit 7212265
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/cmd/outline-ss-server/config.go b/cmd/outline-ss-server/config.go
@@ -115,6 +115,12 @@ func validateListener(u *url.URL) error {
 	return nil
 }
 
+// newListener creates a new listener from a URL-style address specification.
+//
+// Example addresses:
+//
+//	tcp4://127.0.0.1:8000
+//	udp://127.0.0.1:9000
 func newListener(addr string) (io.Closer, error) {
 	u, err := url.Parse(addr)
 	if err != nil {