Permalink
Browse files

Remove non-haddock example from the header of Network.DNS.

Mention thread-safety and purity in the Cabal description field.
Document the re-exported modules in Network.DNS.
  • Loading branch information...
1 parent 060e874 commit d7feac59465b537c63d9ca43e9e5068d7d1216c4 @orlitzky orlitzky committed Sep 12, 2013
Showing with 25 additions and 21 deletions.
  1. +22 −20 Network/DNS.hs
  2. +3 −1 dns.cabal
View
@@ -1,35 +1,37 @@
-{-|
- Thread-safe DNS library written in Haskell.
-
- This code is written in Haskell, not using FFI.
-
- Sample code for DNS lookup:
-
-@
- import qualified Network.DNS as DNS (lookup)
- import Network.DNS hiding (lookup)
- main :: IO ()
- main = do
- rs <- makeResolvSeed defaultResolvConf
- withResolver rs $ \\resolver -> do
- DNS.lookup resolver \"www.example.com\" A >>= print
-@
--}
-
+-- | The Network.DNS module re-exports all other exposed modules for
+-- convenience.
+--
+-- Applications will most likely use the high-level interface, while
+-- library/daemon authors may need to use the lower-level one.
+--
module Network.DNS (
-- * High level
module Network.DNS.Lookup
+ -- | The "Network.DNS.Lookup" module contains simple functions to
+ -- perform various DNS lookups. If you simply want to resolve a
+ -- hostname ('lookupA'), or find a domain's MX record
+ -- ('lookupMX'), this is the easiest way to do it.
+
, module Network.DNS.Resolver
+ -- | The "Network.DNS.Resolver" module is slightly more low-level
+ -- than "Network.DNS.Lookup". If you need to do something unusual,
+ -- you may need to use the 'lookup', 'lookupAuth', or 'lookupRaw'
+ -- functions.
+
, module Network.DNS.Types
+ -- | All of the types that the other modules use.
+
-- * Low level
, module Network.DNS.Decode
+ -- | Decoding a response.
+
, module Network.DNS.Encode
+ -- | Encoding a query.
+
) where
import Network.DNS.Lookup
import Network.DNS.Resolver
import Network.DNS.Types
import Network.DNS.Decode
import Network.DNS.Encode
-
-
View
@@ -5,7 +5,9 @@ Maintainer: Kazu Yamamoto <kazu@iij.ad.jp>
License: BSD3
License-File: LICENSE
Synopsis: DNS library in Haskell
-Description: DNS library for clients and servers.
+Description:
+ A thread-safe DNS library for both clients and servers written
+ in pure Haskell.
Category: Network
Cabal-Version: >= 1.10
Build-Type: Simple

0 comments on commit d7feac5

Please sign in to comment.