Luke Plant avatar Luke Plant committed 873991d

Added some code doc

Comments (0)

Files changed (1)

src/Ella/Framework.hs

 --
 -- The routing mechanism has been designed so that you can write code like the following:
 --
+-- > routes :: [View]
 -- > routes = [
 -- >            empty                                  //-> indexView                 $ decs
 -- >          , "posts/" <+/> empty                    //-> postsView                 $ []
 --
 -- where:
 --
--- >  postsView, indexView :: Request -> IO (Maybe Response)
+-- >  postsView, indexView :: Request -> IO (Maybe Response)  (i.e. View)
 -- >  viewWithStringParam :: String -> Request -> IO (Maybe Response)
 -- >  viewWithIntParam :: Int -> Request -> IO (Maybe Response)
 -- >  viewWithIntAndStringParam :: Int -> String -> Request -> IO (Maybe Response)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.