Haddock for snap-server

lpsmith · May 3, 2010 · 31e92c2 · 31e92c2
1 parent 049f8a9
commit 31e92c2
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 4 deletions.
diff --git a/snap-server.cabal b/snap-server.cabal
@@ -2,7 +2,25 @@ name:           snap-server
 version:        0.1.1
 synopsis:       A fast, iteratee-based, epoll-enabled web server for the Snap Framework
 description:
-  FIXME: Snap is a simple web development framework
+  This is the first developer prerelease of the Snap framework.  Snap is a
+  simple and fast web development framework and server written in Haskell. For
+  more information or to download the latest version, you can visit the Snap
+  project website at <http://snapframework.com/>.
+  .
+  The Snap HTTP server is a high performance, epoll-enabled, iteratee-based web
+  server library written in Haskell. Together with the @snap-core@ library upon
+  which it depends, it provides a clean and efficient Haskell programming
+  interface to the HTTP protocol.
+  .
+  Higher-level facilities for building web applications (like user/session
+  management, component interfaces, data modeling, etc.) are planned but not
+  yet implemented, so this release will mostly be of interest for those who:
+  .
+  * need a fast and minimal HTTP API at roughly the same level of abstraction
+    as Java servlets, or
+  .
+  * are interested in contributing to the Snap Framework project.
+
 license:        BSD3
 license-file:   LICENSE
 author:         James Sanders, Gregory Collins, Doug Beardsley

diff --git a/src/Snap/Http/Server.hs b/src/Snap/Http/Server.hs
@@ -1,3 +1,7 @@
+-- | The Snap HTTP server is a high performance, epoll-enabled, iteratee-based
+-- web server library written in Haskell. Together with the @snap-core@ library
+-- upon which it depends, it provides a clean and efficient Haskell programming
+-- interface to the HTTP protocol.
 module Snap.Http.Server
 (
   httpServe
@@ -8,12 +12,12 @@ import           Snap.Types
 import qualified Snap.Internal.Http.Server as Int
 
 
--- | FIXME: document this
+-- | Starts serving HTTP requests on the given port using the given handler.
 httpServe :: ByteString      -- ^ bind address, or \"*\" for all
           -> Int             -- ^ port to bind to
           -> ByteString      -- ^ local hostname (server name)
-          -> Maybe FilePath  -- ^ path to the access log
-          -> Maybe FilePath  -- ^ path to the error log
+          -> Maybe FilePath  -- ^ path to the (optional) access log
+          -> Maybe FilePath  -- ^ path to the (optional) error log
           -> Snap ()         -- ^ handler procedure
           -> IO ()
 httpServe bindAddress bindPort localHostname alog elog handler =