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 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 .