From 353e0d90ff3693e40c3a9bc1b0d7b6ae0bc8f7c5 Mon Sep 17 00:00:00 2001 From: Dmitry Borzov Date: Mon, 7 Dec 2015 17:48:43 +0300 Subject: [PATCH] Fix package-docstring for dht package --- dht/doc.go | 43 ++++++++++++++++++++----------------------- 1 file changed, 20 insertions(+), 23 deletions(-) diff --git a/dht/doc.go b/dht/doc.go index 66fe6cdc..3e65bc1d 100644 --- a/dht/doc.go +++ b/dht/doc.go @@ -1,25 +1,22 @@ -/* - Package dht implements a Distributed Hash Table (DHT) part of - the BitTorrent protocol, - as specified by BEP 5: http://www.bittorrent.org/beps/bep_0005.html - - BitTorrent uses a "distributed hash table" (DHT) - for storing peer contact information for "trackerless" torrents. - In effect, each peer becomes a tracker. - The protocol is based on Kademila DHT protocol and is implemented over UDP. - - Please note the terminology used to avoid confusion. - A "peer" is a client/server listening on a TCP port that - implements the BitTorrent protocol. - A "node" is a client/server listening on a UDP port implementing - the distributed hash table protocol. - The DHT is composed of nodes and stores the location of peers. - BitTorrent clients include a DHT node, which is used to contact other nodes - in the DHT to get the location of peers to - download from using the BitTorrent protocol. - - Standard use involves creating a Server, and calling Announce on it with - the details of your local torrent client and infohash of interest. -*/ +// Package dht implements a Distributed Hash Table (DHT) part of +// the BitTorrent protocol, +// as specified by BEP 5: http://www.bittorrent.org/beps/bep_0005.html +// +// BitTorrent uses a "distributed hash table" (DHT) +// for storing peer contact information for "trackerless" torrents. +// In effect, each peer becomes a tracker. +// The protocol is based on Kademila DHT protocol and is implemented over UDP. +// +// Please note the terminology used to avoid confusion. +// A "peer" is a client/server listening on a TCP port that +// implements the BitTorrent protocol. +// A "node" is a client/server listening on a UDP port implementing +// the distributed hash table protocol. +// The DHT is composed of nodes and stores the location of peers. +// BitTorrent clients include a DHT node, which is used to contact other nodes +// in the DHT to get the location of peers to +// download from using the BitTorrent protocol. +// Standard use involves creating a Server, and calling Announce on it with +// the details of your local torrent client and infohash of interest. package dht -- 2.48.1