CSHARP-2313: Fix Sandcastle doc comment warnings

Author: vincentkam

Docs/Api/CSharpDriverDocs.shfbproj

@@ -1,7 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">
   <PropertyGroup>
-    <SHFBROOT Condition=" '$(SHFBROOT)' == '' ">$(MSBuildThisFileDirectory)..\..\packages\EWSoftware.SHFB.2017.1.28.0\Tools\</SHFBROOT>
     <ComponentPath>$(MSBuildThisFileDirectory)..\..\packages</ComponentPath>
     <!-- The configuration and platform will be used to determine which
          assemblies to include from solution and project documentation
@@ -54,6 +53,7 @@
       <NamespaceSummaryItem name="MongoDB.Driver.GeoJsonObjectModel.Serializers" isDocumented="True">GeoJson object model serializers.</NamespaceSummaryItem>
       <NamespaceSummaryItem name="MongoDB.Driver.Core.Authentication" isDocumented="True">The MongoDB.Driver.Core.Authentication namespace contains classes related to authentication.</NamespaceSummaryItem>
       <NamespaceSummaryItem name="MongoDB.Driver.Core.Authentication.Sspi" isDocumented="False" />
+      <NamespaceSummaryItem name="MongoDB.Driver.Core.Authentication.Vendored" isDocumented="True">The MongoDB.Driver.Core.Authentication.Vendored contains types and classes vendored in to support authentication.</NamespaceSummaryItem>
       <NamespaceSummaryItem name="MongoDB.Driver.Core.Bindings" isDocumented="True">The MongoDB.Driver.Core.Bindings namespace contains classes related to bindings.</NamespaceSummaryItem>
       <NamespaceSummaryItem name="MongoDB.Driver.Core.Clusters" isDocumented="True">The MongoDB.Driver.Core.Clusters namespace contains classes related to clusters.</NamespaceSummaryItem>
       <NamespaceSummaryItem name="MongoDB.Driver.Core.Clusters.ServerSelectors" isDocumented="True">The MongoDB.Driver.Core.Clusters.ServerSelectors namespace contains classes related to server selectors.</NamespaceSummaryItem>
@@ -72,7 +72,7 @@
       <NamespaceSummaryItem name="MongoDB.Driver.Core.WireProtocol.Messages.Encoders.BinaryEncoders" isDocumented="True">The MongoDB.Driver.Core.WireProtoco.Messages.Encoders.BinaryEncoders namespace contains classes related to binary message encoders.</NamespaceSummaryItem>
       <NamespaceSummaryItem name="MongoDB.Driver.Core.WireProtocol.Messages.Encoders.JsonEncoders" isDocumented="True">The MongoDB.Driver.Core.WireProtoco.Messages.Encoders.JsonEncoders namespace contains classes related to JSON message encoders.</NamespaceSummaryItem>
     </NamespaceSummaries>
-    <CopyrightText>Copyright &amp;#169%3b 2010-2015 MongoDB Inc.</CopyrightText>
+    <CopyrightText>Copyright &amp;#169%3b 2010&amp;ndash%3bpresent MongoDB Inc.</CopyrightText>
     <FeedbackEMailAddress>dotnet-driver%40mongodb.com</FeedbackEMailAddress>
     <FeedbackEMailLinkText>MongoDB</FeedbackEMailLinkText>
     <FrameworkVersion>.NET Framework 4.5</FrameworkVersion>

src/MongoDB.Driver.Core/Core/Authentication/Vendored/HashAlgorithmName.cs

@@ -142,13 +142,27 @@ public override int GetHashCode()
             return _name == null ? 0 : _name.GetHashCode();
         }
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Implements the operator ==.
+        /// </summary>
+        /// <param name="left">The left operand.</param>
+        /// <param name="right">The right operand.</param>
+        /// <returns>
+        /// The result of the == operator.
+        /// </returns>
         public static bool operator ==(HashAlgorithmName left, HashAlgorithmName right)
         {
             return left.Equals(right);
         }
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Implements the operator !=.
+        /// </summary>
+        /// <param name="left">The left operand.</param>
+        /// <param name="right">The right operand.</param>
+        /// <returns>
+        /// The result of the != operator.
+        /// </returns>
         public static bool operator !=(HashAlgorithmName left, HashAlgorithmName right)
         {
             return !(left == right);

src/MongoDB.Driver.Core/Core/Bindings/CoreSession.cs

@@ -57,7 +57,12 @@ public CoreSession(
         }
 
         // public properties
-        /// <inheritdoc />
+        /// <summary>
+        /// Gets the cluster.
+        /// </summary>
+        /// <value>
+        /// The cluster.
+        /// </value>
         public ICluster Cluster => _cluster;
 
         /// <inheritdoc />

src/MongoDB.Driver.Core/Core/Operations/RetryableWriteCommandOperationBase.cs

@@ -211,7 +211,11 @@ public Task<BsonDocument> ExecuteAttemptAsync(RetryableWriteContext context, int
         /// <summary>
         /// Creates the command payloads.
         /// </summary>
-        /// <returns>The command payloads.</returns>
+        /// <param name="channel">The channel.</param>
+        /// <param name="attempt">The attempt.</param>
+        /// <returns>
+        /// The command payloads.
+        /// </returns>
         protected abstract IEnumerable<Type1CommandMessageSection> CreateCommandPayloads(IChannelHandle channel, int attempt);
 
         // private methods

src/MongoDB.Driver.Core/Core/WireProtocol/Messages/CommandMessageSection.cs

@@ -239,6 +239,8 @@ public Type1CommandMessageSection(
     /// <summary>
     /// Represents a Type 1 CommandMessage section.
     /// </summary>
+    /// <typeparam name="TDocument">The type of the document.</typeparam>
+    /// <seealso cref="MongoDB.Driver.Core.WireProtocol.Messages.CommandMessageSection" />
     public class Type1CommandMessageSection<TDocument> : Type1CommandMessageSection where TDocument : class
     {
         // private fields

src/MongoDB.Driver/MongoClientSettings.cs

@@ -578,7 +578,7 @@ public UTF8Encoding WriteEncoding
         /// Gets a MongoClientSettings object intialized with values from a connection string.
         /// </summary>
         /// <param name="connectionString">The connection string.</param>
-        /// <returns></returns>
+        /// <returns>A MongoClientSettings.</returns>
         public static MongoClientSettings FromConnectionString(string connectionString)
         {
             return FromUrl(new MongoUrl(connectionString));

src/MongoDB.Driver/MongoIndexManagerBase.cs

@@ -93,10 +93,10 @@ public virtual string CreateOne(
         /// <inheritdoc />
         public virtual async Task<string> CreateOneAsync(
             CreateIndexModel<TDocument> model,
-            CreateOneIndexOptions createOneIndexOptions = null,
+            CreateOneIndexOptions options = null,
             CancellationToken cancellationToken = default(CancellationToken))
         {
-             var createManyIndexOptions = ToCreateManyIndexesOptions(createOneIndexOptions);
+             var createManyIndexOptions = ToCreateManyIndexesOptions(options);
              var result = await CreateManyAsync(new[] { model }, createManyIndexOptions, cancellationToken).ConfigureAwait(false);
              return result.Single();
         }

src/MongoDB.Driver/packages.config

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="AsyncUsageAnalyzers" version="1.0.0-alpha003" targetFramework="net45" developmentDependency="true" />
-  <package id="EWSoftware.SHFB" version="2017.1.28.0" targetFramework="net45" />
+  <package id="EWSoftware.SHFB" version="2018.5.29" targetFramework="net45" />
   <package id="EWSoftware.SHFB.NETFramework" version="4.6.2" targetFramework="net45" />
 </packages>