udp: rename to udpapi, reformat AniDBUDP documentation

[go-anidb.git] / udp / comm.go

diff --git a/udp/comm.go b/udp/comm.go
index 5d8cd1eb0db0cbd274ed82e37ffc5c1e975cf9bd..348fcc27966346b95d18a8519efd9a9b66db2738 100755 (executable)
--- a/udp/comm.go
+++ b/udp/comm.go
@@ -5,7 +5,7 @@
 //
 // This library doesn't implement caching; beware since aggressive caching is an
 // implementation requirement. Not doing so can get you banned.
-package udp
+package udpapi
 
 import (
        "bytes"
@@ -30,9 +30,14 @@ const (
 )
 
 type AniDBUDP struct {
-       KeepAliveInterval time.Duration // Interval between keep-alive packets; only sent when PUSH notifications are enabled (default: 20 minutes)
-       Timeout           time.Duration // The time to wait before a packet is considered lost (default: 45 seconds)
-       Notifications     chan APIReply // Channel where PUSH notifications are sent to
+       // Interval between keep-alive packets; only sent when PUSH notifications are enabled (default: 20 minutes)
+       KeepAliveInterval time.Duration
+
+       // The time to wait before a packet is considered lost (default: 45 seconds)
+       Timeout time.Duration
+
+       // Channel where PUSH notifications are sent to
+       Notifications chan APIReply
 
        session string