updating comments based on feedback

api/server/httprest/options.go

@@ -6,26 +6,18 @@ import (
 	"github.com/gorilla/mux"
 )
 
-// Option --.
+// Option is a http rest server functional parameter type.
 type Option func(g *Server) error
 
-// WithMuxHandler --.
-func WithMuxHandler(m httpHandler) Option {
-	return func(g *Server) error {
-		g.cfg.handler = m
-		return nil
-	}
-}
-
-// WithHTTPAddr --.
+// WithHTTPAddr sets the full address ( host and port ) of the server.
 func WithHTTPAddr(addr string) Option {
 	return func(g *Server) error {
 		g.cfg.httpAddr = addr
 		return nil
 	}
 }
 
-// WithRouter --.
+// WithRouter sets the internal router of the server, this is required.
 func WithRouter(r *mux.Router) Option {
 	return func(g *Server) error {
 		g.cfg.router = r