inserted Haddock comments to hide the non-Network.XMPP modules, fixed some Haddock problems

Network/XMPP.hs

@@ -19,24 +19,22 @@ with Pontarius XMPP. If not, see <http://www.gnu.org/licenses/>.
 
 -}
 
--- | Module:      $Header$
+-- |
---   Description: A minimalistic and easy-to-use XMPP library
+-- Module:      $Header$
---   Copyright:   Copyright © 2010-2011 Jon Kristensen
+-- Description: Pontarius XMPP API
---   License:     LGPL-3
+-- Copyright:   Copyright © 2010-2011 Jon Kristensen
+-- License:     LGPL-3
 --
---   Maintainer:  info@pontarius.org
+-- Maintainer:  info@pontarius.org
---   Stability:   unstable
+-- Stability:   unstable
---   Portability: portable
+-- Portability: portable
-
---   Pontarius XMPP aims to be a secure, concurrent/event-based and easy-to-use
---   XMPP library for Haskell. It is being actively developed.
 --
---   Note that we are not recommending anyone to use Pontarius XMPP at this time
+-- This module will be documented soon.
---   as it's still in an experimental stage and will have its API and data types
---   modified frequently. See the project's web site at
---   <http://www.pontarius.org/> for more information.
 --
---   This module will be documented soon.
+-- Note that we are not recommending anyone to use Pontarius XMPP at this time
+-- as it's still in an experimental stage and will have its API and data types
+-- modified frequently. See the project's web site at
+-- <http://www.pontarius.org/> for more information.
 
 module Network.XMPP ( -- Network.XMPP.JID
                       Address (..)

Network/XMPP/Address.hs

@@ -20,6 +20,8 @@ with Pontarius XMPP. If not, see <http://www.gnu.org/licenses/>.
 -}
 
 
+{-# OPTIONS_HADDOCK hide #-}
+
 -- TODO: Move away from stringprep for all three profiles.
 
 -- TODO: When no longer using stringprep, do appropriate testing. (Including
@@ -28,16 +30,6 @@ with Pontarius XMPP. If not, see <http://www.gnu.org/licenses/>.
 -- TODO: Unicode 3.2 should be used.
 
 
--- |
--- Module:      $Header$
--- Description: Data type and utility functions for XMPP addresses (JIDs)
--- Copyright:   Copyright © 2010-2011 Jon Kristensen
--- License:     LGPL-3
---
--- Maintainer:  info@pontarius.org
--- Stability:   unstable
--- Portability: portable
---
 -- This module deals with XMPP addresses (also known as JIDs and JabberIDs). For
 -- more information on XMPP addresses, see RFC 6122: XMPP: Address Format.
 --

Network/XMPP/SASL.hs

@@ -19,6 +19,9 @@ with Pontarius XMPP. If not, see <http://www.gnu.org/licenses/>.
 
 -}
 
+
+{-# OPTIONS_HADDOCK hide #-}
+
 -- TODO: Make it possible to include host.
 -- TODO: Host is assumed to be ISO 8859-1; make list of assumptions.
 -- TODO: Can it contain newline characters?

Network/XMPP/Session.hs

@@ -19,11 +19,6 @@ with Pontarius XMPP. If not, see <http://www.gnu.org/licenses/>.
 
 -}
 
--- TODO: Better functions and events for stanzas, IncomingIQ, OutgoingIQ, etc. (ClientSession, ClientStanza)
-
--- TODO: IO function to do everything related to the handle, instead of just connecting.
-
--- TODO: Enumerate in the same thread? Enumerate one element at the time, non-blocking?
 
 -- I believe we need to use the MultiParamTypeClasses extension to be able to
 -- work with arbitrary client states (solving the problem that the ClientState
@@ -31,16 +26,8 @@ with Pontarius XMPP. If not, see <http://www.gnu.org/licenses/>.
 
 {-# LANGUAGE MultiParamTypeClasses #-}
 
--- |
+{-# OPTIONS_HADDOCK hide #-}
--- Module:      $Header$
+
--- Description: XMPP client session management module
--- Copyright:   Copyright © 2010-2011 Jon Kristensen
--- License:     LGPL-3
---
--- Maintainer:  info@pontarius.org
--- Stability:   unstable
--- Portability: portable
---
 -- This module provides the functions used by XMPP clients to manage their XMPP
 -- sessions.
 --
@@ -55,6 +42,12 @@ with Pontarius XMPP. If not, see <http://www.gnu.org/licenses/>.
 --
 -- For more information, see the Pontarius XMPP Manual.
 
+-- TODO: Better functions and events for stanzas, IncomingIQ, OutgoingIQ, etc. (ClientSession, ClientStanza)
+
+-- TODO: IO function to do everything related to the handle, instead of just connecting.
+
+-- TODO: Enumerate in the same thread? Enumerate one element at the time, non-blocking?
+
 module Network.XMPP.Session ( ClientHandler (..)
                             , ClientState (..)
                             , ConnectResult (..)

Network/XMPP/Stanza.hs

@@ -19,16 +19,9 @@ with Pontarius XMPP. If not, see <http://www.gnu.org/licenses/>.
 
 -}
 
--- |
+
--- Module:      $Header$
+{-# OPTIONS_HADDOCK hide #-}
--- Description: XMPP stanza types and utility functions
+
--- Copyright:   Copyright © 2010-2011 Jon Kristensen
--- License:     LGPL-3
---
--- Maintainer:  info@pontarius.org
--- Stability:   unstable
--- Portability: portable
---
 -- The stanza record types are generally pretty convenient to work with.
 -- However, due to the fact that an "IQ" can be both an "IQRequest" and an
 -- "IQResponse" we provide some helper functions in this module that work on
@@ -37,7 +30,6 @@ with Pontarius XMPP. If not, see <http://www.gnu.org/licenses/>.
 -- We also provide functions to create a new stanza ID generator, and to
 -- generate new IDs.
 
-
 module Network.XMPP.Stanza (
 iqID,
 iqFrom,

Network/XMPP/Stream.hs

@@ -1,16 +1,26 @@
------------------------------------------------------------------------------
+{-
---
+
--- Module      :  Network.XMPP.Stream
+Copyright © 2010-2011 Jon Kristensen.
--- Copyright   :  Copyright © 2011, Jon Kristensen
+
--- License     :  UnknownLicense "LGPL3"
+This file is part of Pontarius XMPP.
---
+
--- Maintainer  :  jon.kristensen@pontarius.org
+Pontarius XMPP is free software: you can redistribute it and/or modify it under
--- Stability   :  alpha
+the terms of the GNU Lesser General Public License as published by the Free
--- Portability :
+Software Foundation, either version 3 of the License, or (at your option) any
---
+later version.
--- |
+
---
+Pontarius XMPP is distributed in the hope that it will be useful, but WITHOUT
------------------------------------------------------------------------------
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with Pontarius XMPP. If not, see <http://www.gnu.org/licenses/>.
+
+-}
+
+
+{-# OPTIONS_HADDOCK hide #-}
 
 module Network.XMPP.Stream (
 isTLSSecured,

Network/XMPP/TLS.hs

@@ -1,16 +1,26 @@
------------------------------------------------------------------------------
+{-
---
+
--- Module      :  Network.XMPP.TLS
+Copyright © 2010-2011 Jon Kristensen.
--- Copyright   :  Copyright © 2011, Jon Kristensen
+
--- License     :  LGPL (Just (Version {versionBranch = [3], versionTags = []}))
+This file is part of Pontarius XMPP.
---
+
--- Maintainer  :  jon.kristensen@pontarius.org
+Pontarius XMPP is free software: you can redistribute it and/or modify it under
--- Stability   :  alpha
+the terms of the GNU Lesser General Public License as published by the Free
--- Portability :
+Software Foundation, either version 3 of the License, or (at your option) any
---
+later version.
--- |
+
---
+Pontarius XMPP is distributed in the hope that it will be useful, but WITHOUT
------------------------------------------------------------------------------
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with Pontarius XMPP. If not, see <http://www.gnu.org/licenses/>.
+
+-}
+
+
+{-# OPTIONS_HADDOCK hide #-}
 
 module Network.XMPP.TLS (
 getTLSParams,

Network/XMPP/Types.hs

@@ -1,14 +1,26 @@
------------------------------------------------------------------------------
+{-
---
+
--- Module      :  Types
+Copyright © 2010-2011 Jon Kristensen.
--- Copyright   :  Copyright © 2011, Jon Kristensen
+
--- License     :  LGPL (Just (Version {versionBranch = [3], versionTags = []}))
+This file is part of Pontarius XMPP.
---
+
--- Maintainer  :  jon.kristensen@pontarius.org
+Pontarius XMPP is free software: you can redistribute it and/or modify it under
--- Stability   :  alpha
+the terms of the GNU Lesser General Public License as published by the Free
--- Portability :
+Software Foundation, either version 3 of the License, or (at your option) any
---
+later version.
------------------------------------------------------------------------------
+
+Pontarius XMPP is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with Pontarius XMPP. If not, see <http://www.gnu.org/licenses/>.
+
+-}
+
+
+{-# OPTIONS_HADDOCK hide #-}
 
 {-# LANGUAGE MultiParamTypeClasses #-}
 

Network/XMPP/Utilities.hs

@@ -19,18 +19,8 @@ with Pontarius XMPP. If not, see <http://www.gnu.org/licenses/>.
 
 -}
 
--- |
+
--- Module:      $Header$
+{-# OPTIONS_HADDOCK hide #-}
--- Description: Utility functions for Pontarius XMPP; currently only random ID
---              generation functions
--- Copyright:   Copyright © 2010-2011 Jon Kristensen
--- License:     LGPL-3
---
--- Maintainer:  info@pontarius.org
--- Stability:   unstable
--- Portability: portable
---
--- This module will be documented soon.
 
 -- TODO: Document this module
 -- TODO: Make is possible to customize characters

pontarius-xmpp.cabal

@@ -25,10 +25,7 @@ Tested-With:        GHC ==7.0.2
 -- Extra-Tmp-Files:
 
 Library
-  Exposed-Modules:   Network.XMPP, Network.XMPP.Address, Network.XMPP.SASL,
+  Exposed-Modules:   Network.XMPP
-                     Network.XMPP.Session, Network.XMPP.Stanza,
-                     Network.XMPP.Stream, Network.XMPP.TLS, Network.XMPP.Types,
-                     Network.XMPP.Utilities
   Exposed:           True
   Build-Depends:     base >= 2 && < 5, parsec, enumerator, crypto-api,
                      base64-string, pureMD5, utf8-string, network, xml-types,