Fix golint errors in auth.go

Author: abbot

auth.go

@@ -7,38 +7,31 @@ import (
 	"golang.org/x/net/context"
 )
 
-/*
- Request handlers must take AuthenticatedRequest instead of http.Request
-*/
+// AuthenticatedRequest is passed to AuthenticatedHandlerFunc instead
+// of *http.Request.
 type AuthenticatedRequest struct {
 	http.Request
-	/*
-	 Authenticated user name. Current API implies that Username is
-	 never empty, which means that authentication is always done
-	 before calling the request handler.
-	*/
+	// Username is the authenticated user name. Current API implies that
+	// Username is never empty, which means that authentication is
+	// always done before calling the request handler.
 	Username string
 }
 
-/*
- AuthenticatedHandlerFunc is like http.HandlerFunc, but takes
- AuthenticatedRequest instead of http.Request
-*/
+// AuthenticatedHandlerFunc is like http.HandlerFunc, but takes
+// AuthenticatedRequest instead of http.Request
 type AuthenticatedHandlerFunc func(http.ResponseWriter, *AuthenticatedRequest)
 
-/*
- Authenticator wraps an AuthenticatedHandlerFunc with
- authentication-checking code.
-
- Typical Authenticator usage is something like:
-
-   authenticator := SomeAuthenticator(...)
-   http.HandleFunc("/", authenticator(my_handler))
-
- Authenticator wrapper checks the user authentication and calls the
- wrapped function only after authentication has succeeded. Otherwise,
- it returns a handler which initiates the authentication procedure.
-*/
+// Authenticator wraps an AuthenticatedHandlerFunc with
+// authentication-checking code.
+//
+// Typical Authenticator usage is something like:
+//
+//   authenticator := SomeAuthenticator(...)
+//   http.HandleFunc("/", authenticator(my_handler))
+//
+// Authenticator wrapper checks the user authentication and calls the
+// wrapped function only after authentication has succeeded. Otherwise,
+// it returns a handler which initiates the authentication procedure.
 type Authenticator func(AuthenticatedHandlerFunc) http.HandlerFunc
 
 // Info contains authentication information for the request.
@@ -73,8 +66,14 @@ func (i *Info) UpdateHeaders(headers http.Header) {
 
 type key int // used for context keys
 
-var infoKey key = 0
+var infoKey key
 
+// AuthenticatorInterface is the interface implemented by BasicAuth
+// and DigestAuth authenticators.
+//
+// Deprecated: this interface is not coherent. New code should define
+// and use your own interfaces with a required subset of authenticator
+// methods.
 type AuthenticatorInterface interface {
 	// NewContext returns a new context carrying authentication
 	// information extracted from the request.
@@ -101,6 +100,9 @@ func FromContext(ctx context.Context) *Info {
 // successful).
 const AuthUsernameHeader = "X-Authenticated-Username"
 
+// JustCheck returns a new http.HandlerFunc, which requires
+// authenticator to successfully authenticate a user before calling
+// wrapped http.HandlerFunc.
 func JustCheck(auth AuthenticatorInterface, wrapped http.HandlerFunc) http.HandlerFunc {
 	return auth.Wrap(func(w http.ResponseWriter, ar *AuthenticatedRequest) {
 		ar.Header.Set(AuthUsernameHeader, ar.Username)