From f87c00a638b87599f09f87c6da8911157c595705 Mon Sep 17 00:00:00 2001 From: Sam T Date: Wed, 17 Apr 2013 17:16:56 +0400 Subject: + Add stability and portability doc strings. --- src/Data/Torrent.hs | 7 +++++++ src/Data/Torrent/InfoHash.hs | 7 +++++++ src/Network/Torrent/PeerID.hs | 13 +++++++++++-- src/Network/Torrent/PeerWire.hs | 7 +++++++ src/Network/Torrent/PeerWire/Handshake.hs | 7 +++++++ src/Network/Torrent/Tracker.hs | 9 ++++++++- src/Network/Torrent/Tracker/Scrape.hs | 11 +++++++++-- 7 files changed, 56 insertions(+), 5 deletions(-) diff --git a/src/Data/Torrent.hs b/src/Data/Torrent.hs index f38732f5..d9f59626 100644 --- a/src/Data/Torrent.hs +++ b/src/Data/Torrent.hs @@ -1,3 +1,10 @@ +-- | +-- Copyright : (c) Sam T. 2013 +-- License : MIT +-- Maintainer : pxqr.sta@gmail.com +-- Stability : experimental +-- Portability : portable +-- {-# OPTIONS -fno-warn-orphans #-} {-# LANGUAGE OverloadedStrings #-} -- | This module provides torrent metainfo serialization. diff --git a/src/Data/Torrent/InfoHash.hs b/src/Data/Torrent/InfoHash.hs index a5ba3786..51ce0ecd 100644 --- a/src/Data/Torrent/InfoHash.hs +++ b/src/Data/Torrent/InfoHash.hs @@ -1,3 +1,10 @@ +-- | +-- Copyright : (c) Sam T. 2013 +-- License : MIT +-- Maintainer : pxqr.sta@gmail.com +-- Stability : experimental +-- Portability : portable +-- {-# LANGUAGE GeneralizedNewtypeDeriving, FlexibleInstances #-} module Data.Torrent.InfoHash ( InfoHash (getInfoHash) diff --git a/src/Network/Torrent/PeerID.hs b/src/Network/Torrent/PeerID.hs index 7071bc9b..7d928f80 100644 --- a/src/Network/Torrent/PeerID.hs +++ b/src/Network/Torrent/PeerID.hs @@ -1,8 +1,17 @@ -{-# LANGUAGE OverloadedStrings, GeneralizedNewtypeDeriving #-} -- TODO: tests --- | Recommended method for generation of the peer ID's is 'newPeerID', +-- | +-- Copyright : (c) Sam T. 2013 +-- License : MIT +-- Maintainer : pxqr.sta@gmail.com +-- Stability : experimental +-- Portability : non-portable +-- +-- This module provides 'Peer' and 'PeerID' datatypes and all related +-- operations. +-- Recommended method for generation of the peer ID's is 'newPeerID', -- though this module exports some other goodies for custom generation. -- +{-# LANGUAGE OverloadedStrings, GeneralizedNewtypeDeriving #-} module Network.Torrent.PeerID ( -- * Peer addr Peer(..) diff --git a/src/Network/Torrent/PeerWire.hs b/src/Network/Torrent/PeerWire.hs index 27ecda79..f84b7016 100644 --- a/src/Network/Torrent/PeerWire.hs +++ b/src/Network/Torrent/PeerWire.hs @@ -1,3 +1,10 @@ +-- | +-- Copyright : (c) Sam T. 2013 +-- License : MIT +-- Maintainer : pxqr.sta@gmail.com +-- Stability : experimental +-- Portability : portable +-- {-# LANGUAGE DoAndIfThenElse #-} module Network.Torrent.PeerWire ( module Network.Torrent.PeerWire.Handshake diff --git a/src/Network/Torrent/PeerWire/Handshake.hs b/src/Network/Torrent/PeerWire/Handshake.hs index 8177fe41..733d5785 100644 --- a/src/Network/Torrent/PeerWire/Handshake.hs +++ b/src/Network/Torrent/PeerWire/Handshake.hs @@ -1,3 +1,10 @@ +-- | +-- Copyright : (c) Sam T. 2013 +-- License : MIT +-- Maintainer : pxqr.sta@gmail.com +-- Stability : experimental +-- Portability : portable +-- {-# LANGUAGE OverloadedStrings #-} module Network.Torrent.PeerWire.Handshake ( Handshake diff --git a/src/Network/Torrent/Tracker.hs b/src/Network/Torrent/Tracker.hs index 0d38cc05..ffbdc949 100644 --- a/src/Network/Torrent/Tracker.hs +++ b/src/Network/Torrent/Tracker.hs @@ -1,4 +1,11 @@ --- TODO: add "compact" field +-- TODO: add "compact" field to TRequest +-- | +-- Copyright : (c) Sam T. 2013 +-- License : MIT +-- Maintainer : pxqr.sta@gmail.com +-- Stability : experimental +-- Portability : non-portable +-- {-# OPTIONS -fno-warn-orphans #-} {-# LANGUAGE OverloadedStrings #-} module Network.Torrent.Tracker diff --git a/src/Network/Torrent/Tracker/Scrape.hs b/src/Network/Torrent/Tracker/Scrape.hs index 80a9fc0a..f5ebbea4 100644 --- a/src/Network/Torrent/Tracker/Scrape.hs +++ b/src/Network/Torrent/Tracker/Scrape.hs @@ -1,9 +1,16 @@ -{-# LANGUAGE OverloadedStrings #-} --- | By convention most trackers support anouther form of request, +-- | +-- Copyright : (c) Sam T. 2013 +-- License : MIT +-- Maintainer : pxqr.sta@gmail.com +-- Stability : experimental +-- Portability : portable +-- +-- By convention most trackers support anouther form of request, -- which queries the state of a given torrent (or all torrents) that the -- tracker is managing. This module provides a way to easily request -- scrape info for a particular torrent list. -- +{-# LANGUAGE OverloadedStrings #-} module Network.Torrent.Tracker.Scrape ( ScrapeInfo(..), Scrape , scrapeURL -- cgit v1.2.3