Fixed summary documentation

MarkCiliaVincenti · Nov 27, 2021 · e5f4fc3 · e5f4fc3
1 parent 377ff45
commit e5f4fc3
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 6 deletions.
diff --git a/Samples/CertbotSample/CertbotSample.csproj b/Samples/CertbotSample/CertbotSample.csproj
@@ -7,7 +7,7 @@
 
   <ItemGroup>
     <PackageReference Include="NetworkPorts" Version="1.0.5" />
-    <PackageReference Include="TlsCertificateLoader" Version="2.0.0" />
+    <PackageReference Include="TlsCertificateLoader" Version="2.0.1" />
   </ItemGroup>
 
 </Project>
diff --git a/Samples/CertbotSampleUsingMiddleware/CertbotSampleUsingMiddleware.csproj b/Samples/CertbotSampleUsingMiddleware/CertbotSampleUsingMiddleware.csproj
@@ -6,8 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="NetworkPorts" Version="1.0.5" />
-    <PackageReference Include="TlsCertificateLoader" Version="1.1.7" />
+    <PackageReference Include="TlsCertificateLoader" Version="2.0.1" />
   </ItemGroup>
 
 </Project>
diff --git a/TlsCertificateLoader/Models/TlsCertificateLoaderHstsOptions.cs b/TlsCertificateLoader/Models/TlsCertificateLoaderHstsOptions.cs
@@ -3,11 +3,26 @@
 
 namespace TlsCertificateLoader.Models
 {
+    /// <summary>
+    /// TlsCertificateLoader middleware for Certbot HSTS options
+    /// </summary>
     public class TlsCertificateLoaderHstsOptions : HstsOptions
     {
+        /// <summary>
+        /// Enable or disable HSTS (Strict-Transport-Security header). Defaults to <see langword="true"/>.
+        /// </summary>
         public bool HstsEnabled { get; set; } = true;
+        /// <summary>
+        /// Sets the max-age parameter of the Strict-Transport-Security header. Defaults to 2 years.
+        /// </summary>
         public new TimeSpan MaxAge { get; set; } = TimeSpan.FromDays(365 * 2);
+        /// <summary>
+        /// <inheritdoc cref="HstsOptions.IncludeSubDomains"/>
+        /// </summary>
         public new bool IncludeSubDomains { get; set; } = false;
+        /// <summary>
+        /// <inheritdoc cref="HstsOptions.Preload"/> Defaults to <see langword="true"/>.
+        /// </summary>
         public new bool Preload { get; set; } = true;
     }
 }

diff --git a/TlsCertificateLoader/Models/TlsCertificateLoaderWebOptions.cs b/TlsCertificateLoader/Models/TlsCertificateLoaderWebOptions.cs
@@ -2,10 +2,24 @@
 
 namespace TlsCertificateLoader.Models
 {
+    /// <summary>
+    /// TlsCertificateLoader middleware for Certbot web options
+    /// </summary>
     public class TlsCertificateLoaderWebOptions
     {
+        /// <summary>
+        /// The <see cref="System.Net.IPAddress"/> to listen on. Defaults to <see cref="IPAddress.Any"/>.
+        /// </summary>
         public IPAddress IPAddress { get; set; } = IPAddress.Any;
+
+        /// <summary>
+        /// The HTTPS port to listen on. Defaults to 443.
+        /// </summary>
         public int HttpsPort { get; set; } = 443;
+
+        /// <summary>
+        /// The HTTP port to listen on. Defaults to 80.
+        /// </summary>
         public int HttpPort { get; set; } = 80;
     }
 }
diff --git a/TlsCertificateLoader/TlsCertificateLoader.csproj b/TlsCertificateLoader/TlsCertificateLoader.csproj
@@ -6,16 +6,16 @@
 		<RepositoryUrl>https://github.com/MarkCiliaVincenti/TlsCertificateLoader.git</RepositoryUrl>
 		<PackageProjectUrl>https://github.com/MarkCiliaVincenti/TlsCertificateLoader</PackageProjectUrl>
 		<PackageLicenseFile>LICENSE</PackageLicenseFile>
-		<Version>2.0.0</Version>
+		<Version>2.0.1</Version>
 		<PackageIcon>logo.png</PackageIcon>
 		<PackageReleaseNotes>Added middleware for Certbot certificate loading.</PackageReleaseNotes>
 		<Description>Allows loading of TLS (HTTPS) certificates for .NET 6.0 Kestrel web applications, allowing for refreshing of certificates as well as compatibility with HTTP/3. Includes optional middleware for using certificates obtained by Certbot.</Description>
 		<Copyright>© 2021 Mark Cilia Vincenti</Copyright>
 		<PackageTags>HTTPS,TLS,SSL,Kestrel,HTTP3,HTTP/3,certificates,security,net6,net6.0,Certbot,aspnetcore</PackageTags>
 		<RepositoryType>git</RepositoryType>
 		<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
-		<AssemblyVersion>2.0.0.0</AssemblyVersion>
-		<FileVersion>2.0.0.0</FileVersion>
+		<AssemblyVersion>2.0.1.0</AssemblyVersion>
+		<FileVersion>2.0.1.0</FileVersion>
 		<PackageReadmeFile>README.md</PackageReadmeFile>
 		<IsPackable>true</IsPackable>
 		<EnforceCodeStyleInBuild>True</EnforceCodeStyleInBuild>