Enforce rule IDE0005 on build

(cherry picked from commit 6b1e4ef81938d264a2ddc8b626b0502f799aa640)

Closes #2555

src/Directory.Build.props

@@ -30,6 +30,13 @@
     <!-- A test project gets the test sdk packages automatically added -->
     <TestProject>false</TestProject>
     <TestProject Condition="$(MSBuildProjectName.EndsWith('.Test'))">true</TestProject>
+
+    <!-- XML documentation comments are needed to enforce rule IDE0005 on build -->
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <!--
+        CS1591: Missing XML comment for publicly visible type or member 'Type_or_Member'
+    -->
+    <NoWarn>$(NoWarn);CS1591</NoWarn>
   </PropertyGroup>
 
   <PropertyGroup>

src/NzbDrone.Common/Extensions/BerghelRoach.cs

@@ -356,34 +356,34 @@ public static int GetDistance(char[] target, char[] pattern, int limit = 20)
         }
 
         /**
- * Computes the highest row in which the distance {@code p} appears
- * in diagonal {@code k} of the edit distance computation for
- * strings {@code a} and {@code b}.  The diagonal number is
- * represented by the difference in the indices for the two strings;
- * it can range from {@code -b.length()} through {@code a.length()}.
- *
- * More precisely, this computes the highest value x such that
- * <pre>
- *     p = edit-distance(a[0:(x+k)), b[0:x)).
- * </pre>
- *
- * This is the "f" function described by Ukkonen.
- *
- * The caller must assure that abs(k) &le; p, the only values for
- * which this is well-defined.
- *
- * The implementation depends on the cached results of prior
- * computeRow calls for diagonals k-1, k, and k+1 for distance p-1.
- * These must be supplied in {@code knownLeft}, {@code knownAbove},
- * and {@code knownRight}, respectively.
- * @param k diagonal number
- * @param p edit distance
- * @param a one string to be compared
- * @param b other string to be compared
- * @param knownLeft value of {@code computeRow(k-1, p-1, ...)}
- * @param knownAbove value of {@code computeRow(k, p-1, ...)}
- * @param knownRight value of {@code computeRow(k+1, p-1, ...)}
- */
+         * Computes the highest row in which the distance {@code p} appears
+         * in diagonal {@code k} of the edit distance computation for
+         * strings {@code a} and {@code b}.  The diagonal number is
+         * represented by the difference in the indices for the two strings;
+         * it can range from {@code -b.length()} through {@code a.length()}.
+         *
+         * More precisely, this computes the highest value x such that
+         * <pre>
+         *     p = edit-distance(a[0:(x+k)), b[0:x)).
+         * </pre>
+         *
+         * This is the "f" function described by Ukkonen.
+         *
+         * The caller must assure that abs(k) &#x2264; p, the only values for
+         * which this is well-defined.
+         *
+         * The implementation depends on the cached results of prior
+         * computeRow calls for diagonals k-1, k, and k+1 for distance p-1.
+         * These must be supplied in {@code knownLeft}, {@code knownAbove},
+         * and {@code knownRight}, respectively.
+         * @param k diagonal number
+         * @param p edit distance
+         * @param a one string to be compared
+         * @param b other string to be compared
+         * @param knownLeft value of {@code computeRow(k-1, p-1, ...)}
+         * @param knownAbove value of {@code computeRow(k, p-1, ...)}
+         * @param knownRight value of {@code computeRow(k+1, p-1, ...)}
+         */
         private static int ComputeRow(int k,
             int p,
             char[] a,

src/NzbDrone.Common/OAuth/OAuthRequest.cs

@@ -29,7 +29,7 @@ public class OAuthRequest
         public virtual string Version { get; set; }
         public virtual string SessionHandle { get; set; }
 
-        /// <seealso cref="http://oauth.net/core/1.0#request_urls"/>
+        /// <seealso href="http://oauth.net/core/1.0#request_urls"/>
         public virtual string RequestUrl { get; set; }
         public virtual Dictionary<string, string> Parameters { get; set; }
 

src/NzbDrone.Core/Indexers/TorrentRss/TorrentRssSettingsDetector.cs

@@ -35,13 +35,13 @@ public TorrentRssSettingsDetector(IHttpClient httpClient, Logger logger)
         /// </summary>
         /// <param name="settings">Indexer Settings to use for Parser</param>
         /// <returns>Parsed Settings or <c>null</c></returns>
-        public TorrentRssIndexerParserSettings Detect(TorrentRssIndexerSettings indexerSettings)
+        public TorrentRssIndexerParserSettings Detect(TorrentRssIndexerSettings settings)
         {
-            _logger.Debug("Evaluating TorrentRss feed '{0}'", indexerSettings.BaseUrl);
+            _logger.Debug("Evaluating TorrentRss feed '{0}'", settings.BaseUrl);
 
             try
             {
-                var requestGenerator = new TorrentRssIndexerRequestGenerator { Settings = indexerSettings };
+                var requestGenerator = new TorrentRssIndexerRequestGenerator { Settings = settings };
                 var request = requestGenerator.GetRecentRequests().GetAllTiers().First().First();
 
                 HttpResponse httpResponse = null;
@@ -56,11 +56,11 @@ public TorrentRssIndexerParserSettings Detect(TorrentRssIndexerSettings indexerS
                 }
 
                 var indexerResponse = new IndexerResponse(request, httpResponse);
-                return GetParserSettings(indexerResponse, indexerSettings);
+                return GetParserSettings(indexerResponse, settings);
             }
             catch (Exception ex)
             {
-                ex.WithData("FeedUrl", indexerSettings.BaseUrl);
+                ex.WithData("FeedUrl", settings.BaseUrl);
                 throw;
             }
         }

src/NzbDrone.Core/MetadataSource/Goodreads/Resources/ReviewResource.cs

@@ -40,9 +40,9 @@ public class ReviewResource : GoodreadsResource
         /// </summary>
         public string SpoilersState { get; protected set; }
 
-        /// <summary>
-        /// The shelves the user has added this review to.
-        /// </summary>
+        // /// <summary>
+        // /// The shelves the user has added this review to.
+        // /// </summary>
         // public IReadOnlyList<ReviewShelf> Shelves { get; protected set; }
 
         /// <summary>

src/NzbDrone.Core/MetadataSource/Goodreads/Resources/UserShelfResource.cs

@@ -41,9 +41,9 @@ public sealed class UserShelfResource : GoodreadsResource
         /// </summary>
         public string Sort { get; private set; }
 
-        /// <summary>
-        /// Determines the default sort order of this user shelf.
-        /// </summary>
+        // /// <summary>
+        // /// Determines the default sort order of this user shelf.
+        // /// </summary>
         // public Order? Order { get; private set; }
 
         /// <summary>