Add XML documentation

Add XML documentation for the Swashbuckle.AspNetCore.Newtonsoft package.

Author: martincostello

src/Swashbuckle.AspNetCore.Newtonsoft/DependencyInjection/NewtonsoftServiceCollectionExtensions.cs

@@ -6,8 +6,18 @@
 
 namespace Microsoft.Extensions.DependencyInjection;
 
+/// <summary>
+/// A class containing extension methods for setting up Newtonsoft.Json support. This class cannot be inherited.
+/// </summary>
 public static class NewtonsoftServiceCollectionExtensions
 {
+    /// <summary>
+    /// Add support for using Newtonsoft.Json for serializing OpenAPI documents.
+    /// </summary>
+    /// <param name="services">The <see cref="IServiceCollection"/> to configure.</param>
+    /// <returns>
+    /// The <see cref="IServiceCollection"/> so that additional calls can be chained.
+    /// </returns>
     public static IServiceCollection AddSwaggerGenNewtonsoftSupport(this IServiceCollection services)
     {
         return services.Replace(

src/Swashbuckle.AspNetCore.Newtonsoft/SchemaGenerator/JsonPropertyExtensions.cs

@@ -4,8 +4,19 @@
 
 namespace Swashbuckle.AspNetCore.Newtonsoft;
 
+/// <summary>
+/// A class containing extension methods for the <see cref="JsonProperty"/> class. This class cannot be inherited.
+/// </summary>
 public static class JsonPropertyExtensions
 {
+    /// <summary>
+    /// Tries to get the <see cref="MemberInfo"/> for the given <see cref="JsonProperty"/>.
+    /// </summary>
+    /// <param name="jsonProperty">The <see cref="JsonProperty"/> to get the <see cref="MemberInfo"/> for.</param>
+    /// <param name="memberInfo">When the method returns, contains the <see cref="MemberInfo"/> for the property, if found.</param>
+    /// <returns>
+    /// <see langword="true"/> if the <see cref="MemberInfo"/> was found; otherwise, <see langword="false"/>.
+    /// </returns>
     public static bool TryGetMemberInfo(this JsonProperty jsonProperty, out MemberInfo memberInfo)
     {
         memberInfo = jsonProperty.DeclaringType?
@@ -15,6 +26,13 @@ public static bool TryGetMemberInfo(this JsonProperty jsonProperty, out MemberIn
         return memberInfo != null;
     }
 
+    /// <summary>
+    /// Returns whether the specified <see cref="JsonProperty"/> is specified whether it is required.
+    /// </summary>
+    /// <param name="jsonProperty">The <see cref="JsonProperty"/> to test.</param>
+    /// <returns>
+    /// <see langword="true"/> if the <see cref="JsonProperty"/> specifies whether it is required; otherwise, <see langword="false"/>.
+    /// </returns>
     public static bool IsRequiredSpecified(this JsonProperty jsonProperty)
         => jsonProperty.Required != Required.Default;
 }

src/Swashbuckle.AspNetCore.Newtonsoft/SchemaGenerator/NewtonsoftDataContractResolver.cs

@@ -7,11 +7,16 @@
 
 namespace Swashbuckle.AspNetCore.Newtonsoft;
 
+/// <summary>
+/// A class representing an <see cref="ISerializerDataContractResolver"/> implementation that uses Newtonsoft.Json.
+/// </summary>
+/// <param name="serializerSettings">The <see cref="JsonSerializerSettings"/> to use.</param>
 public class NewtonsoftDataContractResolver(JsonSerializerSettings serializerSettings) : ISerializerDataContractResolver
 {
     private readonly JsonSerializerSettings _serializerSettings = serializerSettings;
     private readonly IContractResolver _contractResolver = serializerSettings.ContractResolver ?? new DefaultContractResolver();
 
+    /// <inheritdoc/>
     public DataContract GetDataContractForType(Type type)
     {
         var effectiveType = Nullable.GetUnderlyingType(type) ?? type;

src/Swashbuckle.AspNetCore.Newtonsoft/Swashbuckle.AspNetCore.Newtonsoft.csproj

@@ -3,6 +3,7 @@
   <PropertyGroup>
     <AssemblyOriginatorKeyFile>Swashbuckle.AspNetCore.Newtonsoft.snk</AssemblyOriginatorKeyFile>
     <Description>Swagger Generator opt-in component to support Newtonsoft.Json serializer behaviors</Description>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <IsPackable>true</IsPackable>
     <PackageTags>swagger;openapi;documentation;discovery;help;webapi;aspnet;aspnetcore;newtonsoft</PackageTags>
     <SignAssembly>true</SignAssembly>