~ Update documentation after refactoring.

3 files changed, 27 insertions, 16 deletions

diff --git a/src/Network/BitTorrent/Tracker.hs b/src/Network/BitTorrent/Tracker.hs
index 75cbdf9b..d069730f 100644
--- a/src/Network/BitTorrent/Tracker.hs
+++ b/src/Network/BitTorrent/Tracker.hs
@@ -5,14 +5,9 @@
 --   Stability   :  experimental
 --   Portability :  non-portable
 --
---   This module provides high level API for peer->tracker
+--   This module provides high level API for peer -> tracker
 --   communication. Tracker is used to discover other peers in the
---   network.
---
---   By convention most trackers support another form of request,
---   which queries the state of a given torrent (or all torrents) that
---   the tracker is managing. This module also provides a way to
---   easily request scrape info for a particular torrent list.
+--   network using torrent info hash.
 --
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE RecordWildCards   #-}
diff --git a/src/Network/BitTorrent/Tracker/HTTP.hs b/src/Network/BitTorrent/Tracker/HTTP.hs
index 38388316..fe690b96 100644
--- a/src/Network/BitTorrent/Tracker/HTTP.hs
+++ b/src/Network/BitTorrent/Tracker/HTTP.hs
@@ -1,3 +1,18 @@
+-- |
+--   Copyright   :  (c) Sam T. 2013
+--   License     :  MIT
+--   Maintainer  :  pxqr.sta@gmail.com
+--   Stability   :  experimental
+--   Portability :  non-portable
+--
+--   The tracker is an HTTP/HTTPS service used to discovery peers for
+--   a particular existing torrent and keep statistics about the
+--   swarm. This module also provides a way to easily request scrape
+--   info for a particular torrent list.
+--
+--   For more information see:
+--   <https://wiki.theory.org/BitTorrentSpecification#Tracker_HTTP.2FHTTPS_Protocol>
+--
 {-# LANGUAGE OverloadedStrings #-}
 module Network.BitTorrent.Tracker.HTTP
        ( askTracker, leaveTracker
diff --git a/src/Network/BitTorrent/Tracker/Protocol.hs b/src/Network/BitTorrent/Tracker/Protocol.hs
index f5898d36..44398920 100644
--- a/src/Network/BitTorrent/Tracker/Protocol.hs
+++ b/src/Network/BitTorrent/Tracker/Protocol.hs
@@ -3,19 +3,20 @@
 --   License     :  MIT
 --   Maintainer  :  pxqr.sta@gmail.com
 --   Stability   :  experimental
---   Portability :  non-portable
+--   Portability :  portable
 --
+--   Every tracker should support announce query. This query is used
+--   to discover peers within swarm and have two-fold effect:
 --
---   This module provides straigthforward Tracker protocol
---   implementation. The tracker is an HTTP/HTTPS service used to
---   discovery peers for a particular existing torrent and keep
---   statistics about the swarm.
+--     * peer doing announce discover other peers using peer list from
+--     the response to the announce query.
 --
---   For more convenient high level API see
---   "Network.BitTorrent.Tracker" module.
+--     * tracker store peer information and use it in the succeeding
+--     requests made by other peers, until the peer info expires.
 --
---   For more information see:
---   <https://wiki.theory.org/BitTorrentSpecification#Tracker_HTTP.2FHTTPS_Protocol>
+--   By convention most trackers support another form of request --
+--   scrape query -- which queries the state of a given torrent (or
+--   a list of torrents) that the tracker is managing.
 --
 {-# OPTIONS -fno-warn-orphans           #-}
 {-# LANGUAGE OverloadedStrings          #-}