Merge pull request #270 from bording/enable-xmldoc-generation

Enable xmldoc generation

Author: michaelklishin

projects/client/RabbitMQ.Client/project.json

@@ -21,14 +21,16 @@
   },
   "buildOptions": {
     "warningsAsErrors": true,
+    "nowarn": [ "CS1591" ],
     "compile": {
       "exclude": [
         "build"
       ],
       "include": [
         "../../../gensrc/autogenerated-api-0-9-1.cs"
       ]
-    }
+    },
+    "xmlDoc": true
   },
   "dependencies": {},
   "frameworks": {

projects/client/RabbitMQ.Client/src/client/api/ConnectionFactory.cs

@@ -188,10 +188,10 @@ public TimeSpan ContinuationTimeout
         }
 
         /// <summary>
-        /// Factory function for creating the <see cref="IEndpointResolver">
+        /// Factory function for creating the <see cref="IEndpointResolver"/>
         /// used to generate a list of endpoints for the ConnectionFactory
         /// to try in order.
-        /// The default value creates an instance of the <see cref="DefaultEndpointResolver">
+        /// The default value creates an instance of the <see cref="DefaultEndpointResolver"/>
         /// using the list of endpoints passed in. The DefaultEndpointResolver shuffles the
         /// provided list each time it is requested.
         /// </summary>

projects/client/RabbitMQ.Client/src/client/api/ConnectionFactoryBase.cs

@@ -59,19 +59,23 @@ public class ConnectionFactoryBase
         public Func<AddressFamily, ITcpClient> SocketFactory = DefaultSocketFactory;
 #endif
 
+#if NETFX_CORE
         /// <summary>
-        /// Creates a new instance of the <see cref="TcpClient"/>.
+        /// Creates a new instance of the <see cref="StreamSocket"/>.
         /// </summary>
-        /// <param name="addressFamily">Specifies the addressing scheme.</param>
-        /// <returns>New instance of a <see cref="TcpClient"/>.</returns>
-#if NETFX_CORE
+        /// <returns>New instance of a <see cref="StreamSocket"/>.</returns>
         public static StreamSocket DefaultSocketFactory()
         {
             StreamSocket tcpClient = new StreamSocket();
             tcpClient.Control.NoDelay = true;
             return tcpClient;
         }
 #else
+        /// <summary>
+        /// Creates a new instance of the <see cref="TcpClient"/>.
+        /// </summary>
+        /// <param name="addressFamily">Specifies the addressing scheme.</param>
+        /// <returns>New instance of a <see cref="TcpClient"/>.</returns>
         public static ITcpClient DefaultSocketFactory(AddressFamily addressFamily)
         {
             var socket = new Socket(addressFamily, SocketType.Stream, ProtocolType.Tcp)

projects/client/RabbitMQ.Client/src/client/api/IModel.cs

@@ -160,7 +160,7 @@ public interface IModel : IDisposable
         /// operation to complete. This method will not return to the
         /// caller until the shutdown is complete.
         /// In comparison to normal <see cref="Close()"/> method, <see cref="Abort()"/> will not throw
-        /// <see cref="Exceptions.AlreadyClosedException"/> or <see cref="IOException"/> or any other <see cref="Exception"/> during closing model.
+        /// <see cref="Exceptions.AlreadyClosedException"/> or <see cref="System.IO.IOException"/> or any other <see cref="Exception"/> during closing model.
         /// </remarks>
         [AmqpMethodDoNotImplement(null)]
         void Abort();

projects/client/RabbitMQ.Client/src/client/api/IQueueingBasicConsumer.cs

@@ -54,7 +54,6 @@ namespace RabbitMQ.Client
     /// This interface is provided to make creation of test doubles
     /// for <see cref="QueueingBasicConsumer" /> easier.
     ///</para>
-    ///<para>
     ///</remarks>
     public interface IQueueingBasicConsumer
     {

projects/client/RabbitMQ.Client/src/client/api/QueueingBasicConsumer.cs

@@ -62,9 +62,9 @@ namespace RabbitMQ.Client
     /// <para>
     /// When the consumer is closed, through BasicCancel or through
     /// the shutdown of the underlying <see cref="IModel"/> or <see cref="IConnection"/>,
-    ///  the  <see cref="SharedQueue.Close"/> method is called, which causes any
+    ///  the  <see cref="SharedQueue{T}.Close"/> method is called, which causes any
     /// Enqueue() operations, and Dequeue() operations when the queue
-    /// is empty, to throw EndOfStreamException (see the comment for <see cref="SharedQueue.Close"/>).
+    /// is empty, to throw EndOfStreamException (see the comment for <see cref="SharedQueue{T}.Close"/>).
     /// </para>
     /// <para>
     /// The following is a simple example of the usage of this class:

projects/client/RabbitMQ.Client/src/client/content/MapMessageReader.cs

@@ -65,7 +65,7 @@ public MapMessageReader(IBasicProperties properties, byte[] payload)
         ///<summary>
         /// Parses the message body into an <see cref="IDictionary{TKey,TValue}"/> instance.
         /// </summary>
-        /// <exception cref="System.Net.ProtocolViolationException"/>.
+        /// <exception cref="RabbitMQ.Client.ProtocolViolationException"/>.
         public IDictionary<string, object> Body
         {
             get

projects/client/RabbitMQ.Client/src/client/messagepatterns/ISubscription.cs

@@ -50,7 +50,6 @@ namespace RabbitMQ.Client.MessagePatterns
     /// This interface is provided to make creation of test doubles
     /// for <see cref="Subscription" /> easier.
     ///</para>
-    ///<para>
     ///</remarks>
     public interface ISubscription : IEnumerable, IEnumerator, IDisposable
     {