From e49ccb787147db08c347935c6c666d9505cc90e5 Mon Sep 17 00:00:00 2001
From: Maximilian Tagher <feedback.tagher@gmail.com>
Date: Sun, 5 Oct 2014 15:06:23 -0700
Subject: [PATCH] Document Route typeclasses

---
 yesod-core/Yesod/Routes/Class.hs | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/yesod-core/Yesod/Routes/Class.hs b/yesod-core/Yesod/Routes/Class.hs
index 9a9e8a41..cc7dd8e5 100644
--- a/yesod-core/Yesod/Routes/Class.hs
+++ b/yesod-core/Yesod/Routes/Class.hs
@@ -10,12 +10,15 @@ import Data.Text (Text)
 import Data.Set (Set)
 
 class Eq (Route a) => RenderRoute a where
-    -- | The type-safe URLs associated with a site argument.
+    -- | The <http://www.yesodweb.com/book/routing-and-handlers type-safe URLs> associated with a site argument.
     data Route a
-    renderRoute :: Route a -> ([Text], [(Text, Text)])
+    renderRoute :: Route a
+                -> ([Text], [(Text, Text)]) -- ^ The path of the URL split on forward slashes, and a list of query parameters with their associated value.
 
 class RenderRoute a => ParseRoute a where
-    parseRoute :: ([Text], [(Text, Text)]) -> Maybe (Route a)
+    parseRoute :: ([Text], [(Text, Text)]) -- ^ The path of the URL split on forward slashes, and a list of query parameters with their associated value.
+               -> Maybe (Route a)
 
 class RenderRoute a => RouteAttrs a where
-    routeAttrs :: Route a -> Set Text
+    routeAttrs :: Route a
+               -> Set Text -- ^ A set of <http://www.yesodweb.com/book/route-attributes attributes associated with the route>.