Fuller docs + version bump

yesod-newsfeed/ChangeLog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.6
+
+* Create new datatype `EntryEnclosure` for self-documentation of `feedEntryEnclosure`.
+
 ## 1.5
 
 ### Yesod/FeedTypes.hs

yesod-newsfeed/Yesod/FeedTypes.hs

@@ -28,6 +28,12 @@ data Feed url = Feed
     , feedEntries     :: [FeedEntry url]
     }
 
+-- | RSS and Atom allow for linked content to be enclosed in a feed entry.
+-- This represents the enclosed content.
+--
+-- Atom feeds ignore 'enclosedSize' and 'enclosedMimeType'.
+--
+-- @since 1.6
 data EntryEnclosure url = EntryEnclosure
     { enclosedUrl :: url
     , enclosedSize :: Int -- ^ Specified in bytes
@@ -43,4 +49,6 @@ data FeedEntry url = FeedEntry
     , feedEntryEnclosure :: Maybe (EntryEnclosure url)
       -- ^ Allows enclosed data: RSS \<enclosure> or Atom \<link
       -- rel=enclosure>
+      --
+      -- @since 1.5
     }

yesod-newsfeed/yesod-newsfeed.cabal

@@ -1,5 +1,5 @@
 name:            yesod-newsfeed
-version:         1.5
+version:         1.6
 license:         MIT
 license-file:    LICENSE
 author:          Michael Snoyman, Patrick Brisbin