haskell/yesod
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #843 from MaxGabriel/documentRoutes

Browse Source 
Document Route typeclasses
This commit is contained in:
Greg Weber 2014-10-05 23:09:47 -05:00
commit dece47fe9e
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
yesod-core/Yesod/Routes/Class.hs
View File

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