From a5d0128654ccf32545d2f09c143c51ccd1a79b50 Mon Sep 17 00:00:00 2001 From: aler9 <46489434+aler9@users.noreply.github.com> Date: Sun, 28 Nov 2021 12:30:28 +0100 Subject: [PATCH] update docs --- client.go | 7 ++++--- server.go | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/client.go b/client.go index 481afee4..017dd6d5 100644 --- a/client.go +++ b/client.go @@ -150,8 +150,9 @@ type Client struct { // disable being redirected to other servers, that can happen during Describe(). // It defaults to false. RedirectDisable bool - // enable communication with servers which don't provide server ports. - // this can be a security issue. + // enable communication with servers which don't provide server ports or use + // different server ports than the ones announced. + // This can be a security issue. // It defaults to false. AnyPortEnable bool // the stream transport (UDP, Multicast or TCP). @@ -417,7 +418,7 @@ func (c *Client) Close() error { } // Wait waits until all client resources are closed. -// This can happen when a read error occurs or when Close() is called. +// This can happen when a fatal error occurs or when Close() is called. func (c *Client) Wait() error { <-c.done return c.closeError diff --git a/server.go b/server.go index 85cfda40..dd254f23 100644 --- a/server.go +++ b/server.go @@ -312,7 +312,7 @@ func (s *Server) Start() error { return nil } -// Close closes all the server resources and waits for the to close. +// Close closes all the server resources and waits for them to close. func (s *Server) Close() error { s.ctxCancel() s.wg.Wait()