(C#) Adding support for "see" URLs in documentation

AutoRest/AutoRest.Core/ClientModel/CompositeType.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 
 namespace Microsoft.Rest.Generator.ClientModel
@@ -61,6 +62,13 @@ public IEnumerable<Property> ComposedProperties
         /// </summary>
         public string Documentation { get; set; }
 
+        /// <summary>
+        /// Gets or sets a URL pointing to related external documentation.
+        /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1056:UriPropertiesShouldNotBeStrings",
+            Justification = "May not parse as a valid URI.")]
+        public string ExternalDocsUrl { get; set; }
+
         /// <summary>
         /// Returns true if any of the properties is a Constant or is 
         /// a CompositeType which ContainsConstantProperties set to true.

AutoRest/AutoRest.Core/ClientModel/Method.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.Linq;
 using System.Net;
@@ -46,7 +47,7 @@ public Method()
         /// <summary>
         /// Gets or sets the HTTP url.
         /// </summary>
-        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1056:UriPropertiesShouldNotBeStrings",
+        [SuppressMessage("Microsoft.Design", "CA1056:UriPropertiesShouldNotBeStrings",
             Justification= "Url might be used as a template, thus making it invalid url in certain scenarios.")]
         public string Url { get; set; }
 
@@ -135,6 +136,13 @@ public Parameter Body
         /// </summary>
         public string Summary { get; set; }
 
+        /// <summary>
+        /// Gets or sets a URL pointing to related external documentation.
+        /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1056:UriPropertiesShouldNotBeStrings",
+            Justification = "May not parse as a valid URI.")]
+        public string ExternalDocsUrl { get; set; }
+
         /// <summary>
         /// Gets or sets the content type.
         /// </summary>

AutoRest/Generators/CSharp/Azure.CSharp.Tests/Expected/AcceptanceTests/AzureBodyDurationAllSync/AutoRestDurationTestService.cs

@@ -264,6 +264,10 @@ public AutoRestDurationTestService(Uri baseUri, ServiceClientCredentials credent
             }
         }
 
+        /// <summary>
+        /// An optional partial-method to perform custom initialization.
+        /// </summary>
+        partial void CustomInitialize();
         /// <summary>
         /// Initializes client properties.
         /// </summary>
@@ -299,6 +303,7 @@ private void Initialize()
                         new Iso8601TimeSpanConverter()
                     }
             };
+            CustomInitialize();
             DeserializationSettings.Converters.Add(new CloudErrorJsonConverter()); 
         }    
     }

AutoRest/Generators/CSharp/Azure.CSharp.Tests/Expected/AcceptanceTests/AzureBodyDurationNoSync/AutoRestDurationTestService.cs

@@ -264,6 +264,10 @@ public AutoRestDurationTestService(Uri baseUri, ServiceClientCredentials credent
             }
         }
 
+        /// <summary>
+        /// An optional partial-method to perform custom initialization.
+        /// </summary>
+        partial void CustomInitialize();
         /// <summary>
         /// Initializes client properties.
         /// </summary>
@@ -299,6 +303,7 @@ private void Initialize()
                         new Iso8601TimeSpanConverter()
                     }
             };
+            CustomInitialize();
             DeserializationSettings.Converters.Add(new CloudErrorJsonConverter()); 
         }    
     }

AutoRest/Generators/CSharp/Azure.CSharp.Tests/Expected/AcceptanceTests/AzureResource/AutoRestResourceFlatteningTestService.cs

@@ -304,6 +304,7 @@ private void Initialize()
         }    
         /// <summary>
         /// Put External Resource as an Array
+        /// <see href="http://tempuri.org" />
         /// </summary>
         /// <param name='resourceArray'>
         /// External Resource as an Array to put
@@ -445,6 +446,7 @@ private void Initialize()
 
         /// <summary>
         /// Get External Resource as an Array
+        /// <see href="http://tempuri.org" />
         /// </summary>
         /// <param name='customHeaders'>
         /// Headers that will be added to request.
@@ -597,6 +599,7 @@ private void Initialize()
 
         /// <summary>
         /// Put External Resource as a Dictionary
+        /// <see href="http://tempuri.org" />
         /// </summary>
         /// <param name='resourceDictionary'>
         /// External Resource as a Dictionary to put
@@ -738,6 +741,7 @@ private void Initialize()
 
         /// <summary>
         /// Get External Resource as a Dictionary
+        /// <see href="http://tempuri.org" />
         /// </summary>
         /// <param name='customHeaders'>
         /// Headers that will be added to request.
@@ -890,6 +894,7 @@ private void Initialize()
 
         /// <summary>
         /// Put External Resource as a ResourceCollection
+        /// <see href="http://tempuri.org" />
         /// </summary>
         /// <param name='resourceComplexObject'>
         /// External Resource as a ResourceCollection to put
@@ -1031,6 +1036,7 @@ private void Initialize()
 
         /// <summary>
         /// Get External Resource as a ResourceCollection
+        /// <see href="http://tempuri.org" />
         /// </summary>
         /// <param name='customHeaders'>
         /// Headers that will be added to request.

AutoRest/Generators/CSharp/Azure.CSharp.Tests/Expected/AcceptanceTests/AzureResource/AutoRestResourceFlatteningTestServiceExtensions.cs

@@ -24,6 +24,7 @@ public static partial class AutoRestResourceFlatteningTestServiceExtensions
     {
             /// <summary>
             /// Put External Resource as an Array
+            /// <see href="http://tempuri.org" />
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -38,6 +39,7 @@ public static partial class AutoRestResourceFlatteningTestServiceExtensions
 
             /// <summary>
             /// Put External Resource as an Array
+            /// <see href="http://tempuri.org" />
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -55,6 +57,7 @@ public static partial class AutoRestResourceFlatteningTestServiceExtensions
 
             /// <summary>
             /// Get External Resource as an Array
+            /// <see href="http://tempuri.org" />
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -66,6 +69,7 @@ public static IList<FlattenedProduct> GetArray(this IAutoRestResourceFlatteningT
 
             /// <summary>
             /// Get External Resource as an Array
+            /// <see href="http://tempuri.org" />
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -83,6 +87,7 @@ public static IList<FlattenedProduct> GetArray(this IAutoRestResourceFlatteningT
 
             /// <summary>
             /// Put External Resource as a Dictionary
+            /// <see href="http://tempuri.org" />
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -97,6 +102,7 @@ public static IList<FlattenedProduct> GetArray(this IAutoRestResourceFlatteningT
 
             /// <summary>
             /// Put External Resource as a Dictionary
+            /// <see href="http://tempuri.org" />
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -114,6 +120,7 @@ public static IList<FlattenedProduct> GetArray(this IAutoRestResourceFlatteningT
 
             /// <summary>
             /// Get External Resource as a Dictionary
+            /// <see href="http://tempuri.org" />
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -125,6 +132,7 @@ public static IDictionary<string, FlattenedProduct> GetDictionary(this IAutoRest
 
             /// <summary>
             /// Get External Resource as a Dictionary
+            /// <see href="http://tempuri.org" />
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -142,6 +150,7 @@ public static IDictionary<string, FlattenedProduct> GetDictionary(this IAutoRest
 
             /// <summary>
             /// Put External Resource as a ResourceCollection
+            /// <see href="http://tempuri.org" />
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -156,6 +165,7 @@ public static IDictionary<string, FlattenedProduct> GetDictionary(this IAutoRest
 
             /// <summary>
             /// Put External Resource as a ResourceCollection
+            /// <see href="http://tempuri.org" />
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -173,6 +183,7 @@ public static IDictionary<string, FlattenedProduct> GetDictionary(this IAutoRest
 
             /// <summary>
             /// Get External Resource as a ResourceCollection
+            /// <see href="http://tempuri.org" />
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -184,6 +195,7 @@ public static ResourceCollection GetResourceCollection(this IAutoRestResourceFla
 
             /// <summary>
             /// Get External Resource as a ResourceCollection
+            /// <see href="http://tempuri.org" />
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.

AutoRest/Generators/CSharp/Azure.CSharp.Tests/Expected/AcceptanceTests/AzureResource/Models/Resource.cs

@@ -16,6 +16,10 @@ namespace Fixtures.Azure.AcceptanceTestsAzureResource.Models
     using Microsoft.Rest.Serialization;
     using Microsoft.Rest.Azure;
 
+    /// <summary>
+    /// Some resource
+    /// <see href="http://tempuri.org" />
+    /// </summary>
     public partial class Resource : IResource
     {
         /// <summary>

AutoRest/Generators/CSharp/Azure.CSharp/Templates/AzureMethodTemplate.cshtml

@@ -18,6 +18,10 @@ if (!string.IsNullOrWhiteSpace(Model.Description) || !string.IsNullOrWhiteSpace(
 {
 @:/// <summary>
 @:@WrapComment("/// ", String.IsNullOrEmpty(Model.Summary) ? Model.Description.EscapeXmlComment() : Model.Summary.EscapeXmlComment())
+if (!string.IsNullOrWhiteSpace(Model.ExternalDocsUrl))
+{
+@:/// <see href="@Model.ExternalDocsUrl" />
+}
 @:/// </summary>
 }
 if (!String.IsNullOrEmpty(Model.Description) && !String.IsNullOrEmpty(Model.Summary))
@@ -53,6 +57,10 @@ if (!String.IsNullOrEmpty(Model.Description) || !String.IsNullOrEmpty(Model.Summ
 {
 @:/// <summary>
 @:@WrapComment("/// ", String.IsNullOrEmpty(Model.Summary) ? Model.Description.EscapeXmlComment() : Model.Summary.EscapeXmlComment())
+if (!string.IsNullOrWhiteSpace(Model.ExternalDocsUrl))
+{
+@:/// <see href="@Model.ExternalDocsUrl" />
+}
 @:/// </summary>
 }
 if (!String.IsNullOrEmpty(Model.Description) && !String.IsNullOrEmpty(Model.Summary))

AutoRest/Generators/CSharp/CSharp.Tests/Expected/AcceptanceTests/ModelFlattening/AutoRestResourceFlatteningTestService.cs

@@ -155,6 +155,7 @@ private void Initialize()
         }    
         /// <summary>
         /// Put External Resource as an Array
+        /// <see href="http://tempuri.org" />
         /// </summary>
         /// <param name='resourceArray'>
         /// External Resource as an Array to put
@@ -269,6 +270,7 @@ private void Initialize()
 
         /// <summary>
         /// Get External Resource as an Array
+        /// <see href="http://tempuri.org" />
         /// </summary>
         /// <param name='customHeaders'>
         /// Headers that will be added to request.
@@ -394,6 +396,7 @@ private void Initialize()
 
         /// <summary>
         /// Put External Resource as a Dictionary
+        /// <see href="http://tempuri.org" />
         /// </summary>
         /// <param name='resourceDictionary'>
         /// External Resource as a Dictionary to put
@@ -508,6 +511,7 @@ private void Initialize()
 
         /// <summary>
         /// Get External Resource as a Dictionary
+        /// <see href="http://tempuri.org" />
         /// </summary>
         /// <param name='customHeaders'>
         /// Headers that will be added to request.
@@ -633,6 +637,7 @@ private void Initialize()
 
         /// <summary>
         /// Put External Resource as a ResourceCollection
+        /// <see href="http://tempuri.org" />
         /// </summary>
         /// <param name='resourceComplexObject'>
         /// External Resource as a ResourceCollection to put
@@ -747,6 +752,7 @@ private void Initialize()
 
         /// <summary>
         /// Get External Resource as a ResourceCollection
+        /// <see href="http://tempuri.org" />
         /// </summary>
         /// <param name='customHeaders'>
         /// Headers that will be added to request.
@@ -872,6 +878,7 @@ private void Initialize()
 
         /// <summary>
         /// Put Simple Product with client flattening true on the model
+        /// <see href="http://tempuri.org" />
         /// </summary>
         /// <param name='simpleBodyProduct'>
         /// Simple body product to put
@@ -1011,6 +1018,7 @@ private void Initialize()
 
         /// <summary>
         /// Put Flattened Simple Product with client flattening true on the parameter
+        /// <see href="http://tempuri.org" />
         /// </summary>
         /// <param name='productId'>
         /// Unique identifier representing a specific product for a given latitude
@@ -1181,6 +1189,7 @@ private void Initialize()
 
         /// <summary>
         /// Put Simple Product with client flattening true on the model
+        /// <see href="http://tempuri.org" />
         /// </summary>
         /// <param name='flattenParameterGroup'>
         /// Additional parameters for the operation