Doc comments

[btrtrc.git] / tracker / udp / conn-client.go

diff --git a/tracker/udp/conn-client.go b/tracker/udp/conn-client.go
index ac920ed099d8aa4df2e4cd9edc6644b8dadb40c6..81e139c96151fbd856d95b5bd528a9456193e1db 100644 (file)
--- a/tracker/udp/conn-client.go
+++ b/tracker/udp/conn-client.go
@@ -9,11 +9,15 @@ import (
 )
 
 type NewConnClientOpts struct {
+       // The network to operate to use, such as "udp4", "udp", "udp6".
        Network string
-       Host    string
-       Ipv6    *bool
+       // Tracker address
+       Host string
+       // If non-nil, forces either IPv4 or IPv6 in the UDP tracker wire protocol.
+       Ipv6 *bool
 }
 
+// Manages a Client with a specific connection.
 type ConnClient struct {
        Client  Client
        conn    net.Conn