From ae2a2d5b00761c2fed51665a0d6f64b8f1042451 Mon Sep 17 00:00:00 2001
From: Matthew Holt <Matthew.Holt+git@gmail.com>
Date: Thu, 29 Jan 2015 23:52:18 -0700
Subject: [PATCH] Godoc for middleware packages and server package

---
 middleware/extensionless/extensionless.go | 2 +-
 middleware/gzip/gzip.go                   | 2 ++
 middleware/headers/headers.go             | 3 +++
 middleware/log/log.go                     | 1 +
 middleware/proxy/proxy.go                 | 2 +-
 middleware/redirect/redirect.go           | 2 +-
 server/server.go                          | 7 +++----
 7 files changed, 12 insertions(+), 7 deletions(-)

diff --git a/middleware/extensionless/extensionless.go b/middleware/extensionless/extensionless.go
index e7224e8c3..eb5a7c9ec 100644
--- a/middleware/extensionless/extensionless.go
+++ b/middleware/extensionless/extensionless.go
@@ -1,4 +1,4 @@
-// Extensionless is middleware for clean URLs. A root path is
+// Package extensionless is middleware for clean URLs. A root path is
 // passed in as well as possible extensions to add, internally,
 // to paths requested. The first path+ext that matches a resource
 // that exists will be used.
diff --git a/middleware/gzip/gzip.go b/middleware/gzip/gzip.go
index 295496e13..c72622620 100644
--- a/middleware/gzip/gzip.go
+++ b/middleware/gzip/gzip.go
@@ -1,3 +1,5 @@
+// Package gzip provides a simple middleware layer that performs
+// gzip compression on the response.
 package gzip
 
 import (
diff --git a/middleware/headers/headers.go b/middleware/headers/headers.go
index 7faf6b64a..ee2803dab 100644
--- a/middleware/headers/headers.go
+++ b/middleware/headers/headers.go
@@ -1,3 +1,6 @@
+// Package headers provides middleware that appends headers to
+// requests based on a set of configuration rules that define
+// which routes receive which headers.
 package headers
 
 import (
diff --git a/middleware/log/log.go b/middleware/log/log.go
index 0a1ec541c..1b2aa7b8d 100644
--- a/middleware/log/log.go
+++ b/middleware/log/log.go
@@ -1,3 +1,4 @@
+// Package log implements basic but useful request logging middleware.
 package log
 
 import (
diff --git a/middleware/proxy/proxy.go b/middleware/proxy/proxy.go
index 440b078d3..23e6aabf7 100644
--- a/middleware/proxy/proxy.go
+++ b/middleware/proxy/proxy.go
@@ -1,4 +1,4 @@
-// Proxy is middleware that proxies requests.
+// Package proxy is middleware that proxies requests.
 package proxy
 
 import (
diff --git a/middleware/redirect/redirect.go b/middleware/redirect/redirect.go
index b7020c5ae..f59b3e800 100644
--- a/middleware/redirect/redirect.go
+++ b/middleware/redirect/redirect.go
@@ -1,4 +1,4 @@
-// Redirect is middleware for redirecting certain requests
+// Package redirect is middleware for redirecting certain requests
 // to other locations.
 package redirect
 
diff --git a/server/server.go b/server/server.go
index 29d8584f1..076eca2fe 100644
--- a/server/server.go
+++ b/server/server.go
@@ -1,7 +1,6 @@
-// Server implements a configurable, general-purpose web server. It
-// relies on configurations obtained from the adjacent config package
-// and can execute middleware as defined by the adjacent middleware
-// package.
+// Package server implements a configurable, general-purpose web server.
+// It relies on configurations obtained from the adjacent config package
+// and can execute middleware as defined by the adjacent middleware package.
 package server
 
 import (