Improved XML documentation and some cleanup

Author: abjerner

src/Skybrud.Umbraco.RssUtils/RssFeed.cs

@@ -34,7 +34,7 @@ public class RssFeed {
 
         /// <summary>
         /// Gets or sets the generator of the feed. If you're a good fellow,
-        /// you will set this to &quot;Skybrud.Umbraco.RssUtils&quot;, but
+        /// you will set this to <code>Skybrud.Umbraco.RssUtils</code>, but
         /// this is not a requirement.
         /// </summary>
         public string Generator { get; set; }
@@ -52,7 +52,7 @@ public class RssFeed {
         /// <summary>
         /// Gets or sets the publication date of the feed. If no publication date has been explicitly
         /// set, the publication date of the most recent item will be used instead - or
-        /// <var>DateTime.Now</var> if the feed is empty.
+        /// <code>DateTime.Now</code> if the feed is empty.
         /// </summary>
         public DateTime PubDate {
             get {
@@ -82,24 +82,24 @@ public RssFeed() {
         }
 
         /// <summary>
-        /// Adds the children of the specified <var>IPublishedContent</var> as RSS items.
+        /// Adds the children of the specified <code>IPublishedContent</code> as RSS items.
         /// </summary>
         /// <param name="parent">The parent of the nodes to be added.</param>
         public RssFeed(IPublishedContent parent) : this() {
             AddRange(parent.Children);
         }
 
         /// <summary>
-        /// Adds the children of the specified <var>IPublishedContent</var> as RSS items.
+        /// Adds the children of the specified <code>IPublishedContent</code> as RSS items.
         /// </summary>
         /// <param name="parent">The parent of the nodes to be added.</param>
-        /// <param name="func">Function to convert an <var>IPublishedContent</var> to <var>RssItem</var>.</param>
+        /// <param name="func">Function to convert an <code>IPublishedContent</code> to <code>RssItem</code>.</param>
         public RssFeed(IPublishedContent parent, Func<IPublishedContent, RssItem> func) : this() {
             AddRange(parent.Children, func);
         }
 
         /// <summary>
-        /// Adds the children of the specified <var>IPublishedContent</var> as RSS items.
+        /// Adds the children of the specified <code>IPublishedContent</code> as RSS items.
         /// </summary>
         /// <param name="title">The title of the RSS feed.</param>
         /// <param name="link">A link to the RSS feed or relevant page.</param>
@@ -111,36 +111,37 @@ public RssFeed(string title, string link, IPublishedContent parent) : this() {
         }
 
         /// <summary>
-        /// Adds the children of the specified <var>IPublishedContent</var> as RSS items.
+        /// Adds the children of the specified <code>IPublishedContent</code> as RSS items.
         /// </summary>
         /// <param name="title">The title of the RSS feed.</param>
         /// <param name="link">A link to the RSS feed or relevant page.</param>
         /// <param name="parent">The parent of the nodes to be added.</param>
-        /// <param name="func">Function to convert an <var>IPublishedContent</var> to <var>RssItem</var>.</param>
+        /// <param name="func">Function to convert an <code>IPublishedContent</code> to <code>RssItem</code>.</param>
         public RssFeed(string title, string link, IPublishedContent parent, Func<IPublishedContent, RssItem> func) : this() {
             Title = title;
             Link = link;
             AddRange(parent.Children, func);
         }
 
         /// <summary>
-        /// Adds the specified collection of <var>IPublishedContent</var> as RSS items.
+        /// Adds the specified collection of <code>IPublishedContent</code> as RSS items.
         /// </summary>
         /// <param name="content">A collection of nodes to be added.</param>
         public RssFeed(IEnumerable<IPublishedContent> content) : this() {
             AddRange(content);
         }
 
         /// <summary>
-        /// Adds the specified collection of <var>IPublishedContent</var> as RSS items.
+        /// Adds the specified collection of <code>IPublishedContent</code> as RSS items.
         /// </summary>
         /// <param name="content">A collection of nodes to be added.</param>
+        /// <param name="func">Function to convert an <code>IPublishedContent</code> to <code>RssItem</code>.</param>
         public RssFeed(IEnumerable<IPublishedContent> content, Func<IPublishedContent, RssItem> func) : this() {
             AddRange(content, func);
         }
 
         /// <summary>
-        /// Adds the specified collection of <var>IPublishedContent</var> as RSS items.
+        /// Adds the specified collection of <code>IPublishedContent</code> as RSS items.
         /// </summary>
         /// <param name="title">The title of the RSS feed.</param>
         /// <param name="link">A link to the RSS feed or relevant page.</param>
@@ -152,12 +153,12 @@ public RssFeed(string title, string link, IEnumerable<IPublishedContent> content
         }
 
         /// <summary>
-        /// Adds the specified collection of <var>IPublishedContent</var> as RSS items.
+        /// Adds the specified collection of <code>IPublishedContent</code> as RSS items.
         /// </summary>
         /// <param name="title">The title of the RSS feed.</param>
         /// <param name="link">A link to the RSS feed or relevant page.</param>
         /// <param name="content">A collection of nodes to be added.</param>
-        /// <param name="func">Function to convert an <var>IPublishedContent</var> to <var>RssItem</var>.</param>
+        /// <param name="func">Function to convert an <code>IPublishedContent</code> to <code>RssItem</code>.</param>
         public RssFeed(string title, string link, IEnumerable<IPublishedContent> content, Func<IPublishedContent, RssItem> func) : this() {
             Title = title;
             Link = link;
@@ -193,7 +194,7 @@ private void SortItems() {
             _items = _items.OrderByDescending(x => x.PubDate).ToList();
         }
 
-        public XDocument ToXDocument() {
+        public virtual XDocument ToXDocument() {
 
             // Initialize the root element of the feed
             XElement xRss = new XElement("rss");
@@ -207,6 +208,7 @@ public XDocument ToXDocument() {
             );
 
             xRss.Add(xChannel);
+
             // Add extra elements to the channel (if specified)
             if (!String.IsNullOrWhiteSpace(Generator)) xChannel.Add(new XElement("generator", Generator));
             if (!String.IsNullOrWhiteSpace(Description)) xChannel.Add(new XElement("description", Description));

src/Skybrud.Umbraco.RssUtils/RssItem.cs

@@ -21,23 +21,20 @@ public class RssItem {
         public DateTime PubDate { get; set; }
 
         /// <summary>
-        /// Gets or sets the GUID (global unique identifier) of the feed item.
-        /// A GUID could be URL of the feed item or some other unique value
-        /// that identifies the item.
+        /// Gets or sets the GUID (global unique identifier) of the feed item. A GUID could be URL of the feed item or
+        /// some other unique value that identifies the item.
         /// </summary>
         public string Guid { get; set; }
 
         /// <summary>
-        /// Gets or sets the description of the feed item. If this property is
-        /// specified, a &lt;description&gt; element will be inserted in the
-        /// XML representing the feed item.
+        /// Gets or sets the description of the feed item. If this property is specified, a <code>description</code>
+        /// element will be inserted in the XML representing the feed item.
         /// </summary>
         public string Description { get; set; }
 
         /// <summary>
-        /// Gets or sets the content of the feed item. If this property is
-        /// specified, a &lt;content:encoded&gt; element will be inserted in
-        /// the XML representing the feed item.
+        /// Gets or sets the content of the feed item. If this property is specified, a <code>content:encoded</code>
+        /// element will be inserted in the XML representing the feed item.
         /// </summary>
         public string Content { get; set; }