udp: rename to udpapi, reformat AniDBUDP documentation

diff --git a/udp/aes.go b/udp/aes.go
index f86039229cdcc850d53ff86036e89ef7aa630a33..51beac3f3b421f03386343ca7857d99e40d7a2bf 100755 (executable)
--- a/udp/aes.go
+++ b/udp/aes.go
@@ -1,4 +1,4 @@
-package udp
+package udpapi
 
 import (
        "crypto/aes"

diff --git a/udp/aes_test.go b/udp/aes_test.go
index b3d09f79b34a9c8f905e588d2f4a9f7705b01ba9..9b7dff23daffab40fa88ad56e8fdcfd615e1f379 100755 (executable)
--- a/udp/aes_test.go
+++ b/udp/aes_test.go
@@ -1,4 +1,4 @@
-package udp
+package udpapi
 
 import (
        "testing"

diff --git a/udp/auth.go b/udp/auth.go
index 883c0a29e9e75d6762092fc6d09ca2e5dbb395e6..4f052e166dbba8d06f8c1def1ecc787469f27eaf 100755 (executable)
--- a/udp/auth.go
+++ b/udp/auth.go
@@ -1,4 +1,4 @@
-package udp
+package udpapi
 
 // Authenticates the supplied user with the supplied password. Blocks until we have a reply.
 // Needed before almost any other API command can be used.

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
 

diff --git a/udp/misc.go b/udp/misc.go
index fc697bafd49711de56a4edbf70c824e50868a52d..c2901361cf2803406ff07b53311c08263a4717d3 100755 (executable)
--- a/udp/misc.go
+++ b/udp/misc.go
@@ -1,4 +1,4 @@
-package udp
+package udpapi
 
 type UptimeReply struct {
        APIReply

diff --git a/udp/packet.go b/udp/packet.go
index 538ac77caec9c1b298dbe1af7aadc71d533b38c9..22a693f745d8bf997c2a0a0021ebcd261111ad1e 100755 (executable)
--- a/udp/packet.go
+++ b/udp/packet.go
@@ -1,4 +1,4 @@
-package udp
+package udpapi
 
 import (
        "bytes"

diff --git a/udp/reply.go b/udp/reply.go
index 5c3f047d9a911a5677cc4b8d23b417b1b468b9b6..c4ab2385528ff4df66edbd71a6588e9312b00764 100755 (executable)
--- a/udp/reply.go
+++ b/udp/reply.go
@@ -1,4 +1,4 @@
-package udp
+package udpapi
 
 import (
        "reflect"

diff --git a/udp/sendqueue.go b/udp/sendqueue.go
index 1dc6320eeadbbc6188b20d817e830158f7901354..b469ad94e719d92f6173ca72a1e8dc47efb4bde9 100755 (executable)
--- a/udp/sendqueue.go
+++ b/udp/sendqueue.go
@@ -1,4 +1,4 @@
-package udp
+package udpapi
 
 import (
        "time"