Included docs to NuGet packages

guryanovev · May 29, 2023 · 0c652ae · 0c652ae
1 parent 8672e80
commit 0c652ae
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 17 deletions.
diff --git a/src/CommonAssemblyInfo.cs b/src/CommonAssemblyInfo.cs
@@ -10,5 +10,5 @@
 using System.Reflection;
 
 [assembly: AssemblyProductAttribute("CrystalQuartz")]
-[assembly: AssemblyVersionAttribute("7.0.0.22")]
-[assembly: AssemblyFileVersionAttribute("7.0.0.22")]
+[assembly: AssemblyVersionAttribute("7.0.0.25")]
+[assembly: AssemblyFileVersionAttribute("7.0.0.25")]
diff --git a/src/CrystalQuartz.AspNetCore/CrystalQuartz.AspNetCore.csproj b/src/CrystalQuartz.AspNetCore/CrystalQuartz.AspNetCore.csproj
@@ -7,6 +7,7 @@
 		<PackageId>$(AssemblyName)</PackageId>
 		<CodeAnalysisRuleSet>../../common.ruleset</CodeAnalysisRuleSet>
 		<Nullable>enable</Nullable>
+		<GenerateDocumentationFile>true</GenerateDocumentationFile>
 	</PropertyGroup>
 
 	<ItemGroup>

diff --git a/src/CrystalQuartz.Build/Extensions/SpecInputExtensions.cs b/src/CrystalQuartz.Build/Extensions/SpecInputExtensions.cs
@@ -38,18 +38,30 @@ public static GenerateNuGetSpecTask FillCommonProperties(
         {
             IFile logoFile = solutionDir/"assets"/"logo.png";
 
-            return libBinaries.Aggregate(
-                input
-                    .Version(version)
-                    .Authors("Eugene Guryanov")
-                    .Owners("Eugene Guryanov")
-                    .LicenseUrl("https://github.com/guryanovev/CrystalQuartz/blob/master/LICENCE.txt")
-                    .ProjectUrl("https://github.com/guryanovev/CrystalQuartz")
-                    .Tags(".NET", "ASP.NET", "Quartz.NET", "Scheduler", "Job", "Trigger")
-                    .WithDependenciesFromPackagesConfig(dependenciesProject, ignoreFrameworkVersion: true)
-                    .WithFile(logoFile, "images"),
-
-                (x, file) => x.WithFile(file.File.GetRelativePath(dependenciesProject.Parent.Parent/"Artifacts"), "lib/" + file.TargetVersion));
+            return libBinaries
+                .Concat(
+                    libBinaries
+                        .Select(libFile =>
+                        {
+                            IFile xmlDocFile = libFile.File.Directory / (libFile.File.NameWithoutExtension + ".xml");
+
+                            return new TargetedFile(xmlDocFile, libFile.TargetVersion);
+                        })
+                        .Where(targetFile => targetFile.File.Exists))
+                .Aggregate(
+                    input
+                        .Version(version)
+                        .Authors("Eugene Guryanov")
+                        .Owners("Eugene Guryanov")
+                        .LicenseUrl("https://github.com/guryanovev/CrystalQuartz/blob/master/LICENCE.txt")
+                        .ProjectUrl("https://github.com/guryanovev/CrystalQuartz")
+                        .Tags(".NET", "ASP.NET", "Quartz.NET", "Scheduler", "Job", "Trigger")
+                        .WithDependenciesFromPackagesConfig(dependenciesProject, ignoreFrameworkVersion: true)
+                        .WithFile(logoFile, "images")
+                        ,
+
+                    (x, file) => x.WithFile(
+                        file.File.GetRelativePath(dependenciesProject.Parent.Parent/"Artifacts"), "lib/" + file.TargetVersion));
         }
     }
 }
diff --git a/src/CrystalQuartz.Build/Tasks/MergeBinariesTask.cs b/src/CrystalQuartz.Build/Tasks/MergeBinariesTask.cs
@@ -177,7 +177,7 @@ private ITask<Nothing> CreateMergeTask(string outputDllName, string[] inputAssem
                 ToolPath = ilMergePackage/"tools"/"ILRepack.exe",
 
                 Arguments = string.Format(
-                    "{0}/out:{1} {2}",
+                    "{0}/out:{1} /xmldocs {2}",
                     libs == null || libs.Length == 0 ? string.Empty : (string.Join(" ", libs.Select(x => "/lib:" + x)) + " "),
                     bin/(_configuration + "_Merged")/dotNetVersionAlias/outputDllName,
                     string.Join(" ",

diff --git a/src/CrystalQuartz.Core/CrystalQuartz.Core.csproj b/src/CrystalQuartz.Core/CrystalQuartz.Core.csproj
@@ -8,6 +8,7 @@
 		<CodeAnalysisRuleSet>../../common.ruleset</CodeAnalysisRuleSet>
 		<LangVersion>8</LangVersion>
 		<Nullable>enable</Nullable>
+		<GenerateDocumentationFile>true</GenerateDocumentationFile>
 	</PropertyGroup>
 	<ItemGroup>
 		<Compile Include="..\CommonAssemblyInfo.cs">

diff --git a/src/CrystalQuartz.Core/Services/IEventsTransformer.cs b/src/CrystalQuartz.Core/Services/IEventsTransformer.cs
@@ -2,6 +2,9 @@
 {
     using CrystalQuartz.Core.Domain.Events;
 
+    /// <summary>
+    /// Describes events transformation service.
+    /// </summary>
     public interface IEventsTransformer
     {
         /// <summary>
@@ -10,7 +13,7 @@ public interface IEventsTransformer
         /// </summary>
         /// <param name="id">new id to assign.</param>
         /// <param name="rawEvent">emitted event.</param>
-        /// <returns></returns>
+        /// <returns>Transformed event.</returns>
         SchedulerEvent Transform(int id, RawSchedulerEvent rawEvent);
     }
 }
diff --git a/src/CrystalQuartz.Owin/CrystalQuartz.Owin.csproj b/src/CrystalQuartz.Owin/CrystalQuartz.Owin.csproj
@@ -6,6 +6,7 @@
 		<RestorePackages>true</RestorePackages>
 		<OutputPath>..\..\Artifacts\bin\$(Configuration)</OutputPath>
 		<CodeAnalysisRuleSet>../../common.ruleset</CodeAnalysisRuleSet>
+		<GenerateDocumentationFile>true</GenerateDocumentationFile>
 	</PropertyGroup>
 
 	<PropertyGroup>

diff --git a/src/CrystalQuartz.Web/CrystalQuartz.Web.csproj b/src/CrystalQuartz.Web/CrystalQuartz.Web.csproj
@@ -9,6 +9,7 @@
 		<CodeAnalysisRuleSet>../../common.ruleset</CodeAnalysisRuleSet>
 		<LangVersion>8</LangVersion>
 		<Nullable>enable</Nullable>
+		<GenerateDocumentationFile>true</GenerateDocumentationFile>
 	</PropertyGroup>
 
 	<ItemGroup>

diff --git a/src/version.txt b/src/version.txt
@@ -1 +1 @@
-7.0.0.22
+7.0.0.25