xml comments

Author: mihaj

src/QAToolKit.Source.Swagger/QAToolKit.Source.Swagger.csproj

@@ -2,6 +2,7 @@
 
 	<PropertyGroup>
 		<TargetFrameworks>netstandard2.0;netstandard2.1;netcoreapp3.1</TargetFrameworks>
+		<GenerateDocumentationFile>true</GenerateDocumentationFile>
 		<LangVersion>latest</LangVersion>
 
 		<!-- NuGet Metadata -->
@@ -10,7 +11,7 @@
 		<PackageId>QAToolKit.Source.Swagger</PackageId>
 		<Authors>QAToolKit</Authors>
 		<Description>
-			QAToolKit Swagger library, that parses Swagger files and produces a common list of HTTP requests. 
+			QAToolKit Swagger library, that parses Swagger files and produces a common list of HTTP requests.
 		</Description>
 		<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
 		<PackageLicenseFile>LICENSE</PackageLicenseFile>
@@ -21,15 +22,19 @@
 		<Configurations>Debug;Release;Debug With Project References</Configurations>
 	</PropertyGroup>
 
+	<PropertyGroup>
+		<DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
+	</PropertyGroup>
+
 	<ItemGroup>
 		<None Include="..\..\qatoolkit-64x64.png" Pack="true" PackagePath="\" />
 		<None Include="..\..\LICENSE" Pack="true" PackagePath="" />
 	</ItemGroup>
 
 	<ItemGroup>
-	  <PackageReference Include="Microsoft.OpenApi" Version="1.2.3" />
-	  <PackageReference Include="Microsoft.OpenApi.Readers" Version="1.2.3" />
-	  <PackageReference Include="QAToolKit.Core" Version="0.1.0" />
+		<PackageReference Include="Microsoft.OpenApi" Version="1.2.3" />
+		<PackageReference Include="Microsoft.OpenApi.Readers" Version="1.2.3" />
+		<PackageReference Include="QAToolKit.Core" Version="0.1.0" />
 	</ItemGroup>
 
 </Project>

src/QAToolKit.Source.Swagger/SwaggerFileSource.cs

@@ -8,10 +8,17 @@
 
 namespace QAToolKit.Source.Swagger
 {
+    /// <summary>
+    /// Swagger file source
+    /// </summary>
     public class SwaggerFileSource : ITestSource<IList<FileInfo>, IList<HttpTestRequest>>
     {
         private SwaggerOptions _swaggerOptions;
 
+        /// <summary>
+        /// New instance of swagger file source
+        /// </summary>
+        /// <param name="options"></param>
         public SwaggerFileSource(Action<SwaggerOptions> options = null)
         {
             _swaggerOptions = new SwaggerOptions();

src/QAToolKit.Source.Swagger/SwaggerProcessor.cs

@@ -7,6 +7,9 @@
 
 namespace QAToolKit.Source.Swagger
 {
+    /// <summary>
+    /// Swagger processor
+    /// </summary>
     public class SwaggerProcessor
     {
         /// <summary>

src/QAToolKit.Source.Swagger/SwaggerUrlSource.cs

@@ -11,10 +11,17 @@
 
 namespace QAToolKit.Source.Swagger
 {
+    /// <summary>
+    /// Swagger Url source
+    /// </summary>
     public class SwaggerUrlSource : ITestSource<Uri[], IList<HttpTestRequest>>
     {
         private SwaggerOptions _swaggerOptions;
 
+        /// <summary>
+        /// Swagger Url source constructor
+        /// </summary>
+        /// <param name="options"></param>
         public SwaggerUrlSource(Action<SwaggerOptions> options = null)
         {
             _swaggerOptions = new SwaggerOptions();
@@ -25,7 +32,6 @@ public SwaggerUrlSource(Action<SwaggerOptions> options = null)
         /// Load swagger files from the URL and apply loader settings if necessary
         /// </summary>
         /// <param name="source"></param>
-        /// <param name="options"></param>
         /// <returns></returns>
         public async Task<IList<HttpTestRequest>> Load(Uri[] source)
         {