documentation fixes

This commit is contained in:
patrick brisbin 2011-01-18 17:41:55 -05:00
parent be89f673ae
commit 45265660f7
2 changed files with 12 additions and 3 deletions

View File

@ -14,8 +14,7 @@
-- --
--------------------------------------------------------- ---------------------------------------------------------
-- | Generation of Atom newsfeeds. See -- | Generation of Atom newsfeeds.
-- <http://en.wikipedia.org/wiki/Atom_(standard)>.
module Yesod.Helpers.AtomFeed module Yesod.Helpers.AtomFeed
( atomFeed ( atomFeed
, atomLink , atomLink

View File

@ -8,9 +8,12 @@
-- Stability : Stable -- Stability : Stable
-- Portability : Portable -- Portability : Portable
-- --
-- Generic Feed and Feed Entry data types that can be used as either and -- Generic Feed and Feed Entry data types that can be used as either an
-- Rss feed or an Atom feed (or both, or other). -- Rss feed or an Atom feed (or both, or other).
-- --
-- Atom spec: <http://en.wikipedia.org/wiki/Atom_(standard)>
-- Rss spec: <http://www.rssboard.org/rss-specification#sampleFiles>
--
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
module Yesod.Helpers.Feed module Yesod.Helpers.Feed
( Feed(..) ( Feed(..)
@ -25,8 +28,15 @@ data Feed url = Feed
{ feedTitle :: String { feedTitle :: String
, feedLinkSelf :: url , feedLinkSelf :: url
, feedLinkHome :: url , feedLinkHome :: url
-- | note: currently only used for Rss
, feedDescription :: Html , feedDescription :: Html
-- | note: currently only used for Rss, possible values:
-- <http://www.rssboard.org/rss-language-codes>
, feedLanguage :: String , feedLanguage :: String
, feedUpdated :: UTCTime , feedUpdated :: UTCTime
, feedEntries :: [FeedEntry url] , feedEntries :: [FeedEntry url]
} }