Fixup a couple of warnings.

DanRigby · Sep 23, 2024 · 8e50fad · 8e50fad
1 parent 3e1efcc
commit 8e50fad
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 1 deletion.
diff --git a/JsonFeedNet/JsonFeed.cs b/JsonFeedNet/JsonFeed.cs
@@ -5,6 +5,9 @@ namespace JsonFeedNet;
 using System.Text;
 using System.Text.Json.Serialization;
 
+/// <summary>
+///     Represents a JSON Feed.
+/// </summary>
 // ReSharper disable MemberCanBePrivate.Global
 // ReSharper disable UnusedMember.Global
 public class JsonFeed

diff --git a/JsonFeedNet/JsonFeedItem.cs b/JsonFeedNet/JsonFeedItem.cs
@@ -95,6 +95,10 @@ public class JsonFeedItem
     [Obsolete("obsolete by specification version 1.1. Use `Authors`")]
     public JsonFeedAuthor Author { get; set; } //optional
 
+    /// <summary>
+    ///     Feed item authors.
+    ///     If not specified, then the top-level author, if present, is the author of the item.
+    /// </summary>
     [JsonPropertyName("authors")]
     public List<JsonFeedAuthor> Authors { get; set; } //optional
 

diff --git a/JsonFeedNet/JsonFeedNet.csproj b/JsonFeedNet/JsonFeedNet.csproj
@@ -25,6 +25,7 @@
     <IncludeSymbols>true</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     <IsAotCompatible Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net7.0'))">true</IsAotCompatible>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard2.0' OR '$(TargetFramework)' == 'net6.0' ">

diff --git a/JsonFeedNet/SourceGenerationContext.cs b/JsonFeedNet/SourceGenerationContext.cs
@@ -12,6 +12,6 @@ namespace JsonFeedNet;
 [JsonSerializable(typeof(JsonFeedAuthor))]
 [JsonSerializable(typeof(JsonFeedHub))]
 [JsonSerializable(typeof(JsonFeedItem))]
-internal partial class SourceGenerationContext : JsonSerializerContext
+internal sealed partial class SourceGenerationContext : JsonSerializerContext
 {
 }