Add comments and partial attribute to all interfaces and classes

Author: NickKellett

src/Deploy.LaunchPad.AWS.Abp/ApiGateway/AwsApiGatewayHelperFactory.cs

@@ -1,4 +1,17 @@
-using Abp.Dependency;
+// ***********************************************************************
+// Assembly         : Deploy.LaunchPad.AWS.Abp
+// Author           : Nicholas Kellett
+// Created          : 11-19-2023
+//
+// Last Modified By : Nicholas Kellett
+// Last Modified On : 01-08-2023
+// ***********************************************************************
+// <copyright file="AwsApiGatewayHelperFactory.cs" company="Deploy Software Solutions, inc.">
+//     2021-2023 Deploy Software Solutions, inc.
+// </copyright>
+// <summary></summary>
+// ***********************************************************************
+using Abp.Dependency;
 using Amazon;
 using Amazon.APIGateway;
 using Castle.Core.Logging;
@@ -7,14 +20,35 @@
 
 namespace Deploy.LaunchPad.AWS.Abp.ApiGateway
 {
+    /// <summary>
+    /// Class AwsApiGatewayHelperFactory.
+    /// Implements the <see cref="Deploy.LaunchPad.AWS.AwsHelperBase{Amazon.APIGateway.AmazonAPIGatewayConfig}" />
+    /// Implements the <see cref="ISingletonDependency" />
+    /// </summary>
+    /// <seealso cref="Deploy.LaunchPad.AWS.AwsHelperBase{Amazon.APIGateway.AmazonAPIGatewayConfig}" />
+    /// <seealso cref="ISingletonDependency" />
     public partial class AwsApiGatewayHelperFactory : AwsHelperBase<AmazonAPIGatewayConfig>, ISingletonDependency
     {
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AwsApiGatewayHelperFactory"/> class.
+        /// </summary>
+        /// <param name="logger">The logger.</param>
+        /// <param name="awsRegionEndpointName">Name of the aws region endpoint.</param>
         public AwsApiGatewayHelperFactory(ILogger logger, string awsRegionEndpointName) : base(logger, awsRegionEndpointName)
         {
 
         }
 
+        /// <summary>
+        /// Creates the specified logger.
+        /// </summary>
+        /// <param name="logger">The logger.</param>
+        /// <param name="apiGatewayBaseUri">The API gateway base URI.</param>
+        /// <param name="awsRegionEndpointName">Name of the aws region endpoint.</param>
+        /// <param name="awsProfileName">Name of the aws profile.</param>
+        /// <param name="shouldUseLocalAwsProfile">if set to <c>true</c> [should use local aws profile].</param>
+        /// <returns>AwsApiGatewayHelper.</returns>
         public virtual AwsApiGatewayHelper Create(
             ILogger logger,
             Uri apiGatewayBaseUri,

src/Deploy.LaunchPad.AWS.Abp/ApiGateway/Services/AwsApiGatewayService.cs

@@ -1,19 +1,55 @@
-using Castle.Core.Logging;
+// ***********************************************************************
+// Assembly         : Deploy.LaunchPad.AWS.Abp
+// Author           : Nicholas Kellett
+// Created          : 11-19-2023
+//
+// Last Modified By : Nicholas Kellett
+// Last Modified On : 03-21-2023
+// ***********************************************************************
+// <copyright file="AwsApiGatewayService.cs" company="Deploy Software Solutions, inc.">
+//     2021-2023 Deploy Software Solutions, inc.
+// </copyright>
+// <summary></summary>
+// ***********************************************************************
+using Castle.Core.Logging;
 using Deploy.LaunchPad.AWS.ApiGateway.Services;
 using Deploy.LaunchPad.Core.Abp.Application;
 using Microsoft.Extensions.Configuration;
 using System;
 
 namespace Deploy.LaunchPad.AWS.Abp.ApiGateway.Services
 {
+    /// <summary>
+    /// Class AwsApiGatewayService.
+    /// Implements the <see cref="LaunchPadAbpSystemIntegrationServiceBase" />
+    /// Implements the <see cref="IAwsApiGatewayService" />
+    /// </summary>
+    /// <seealso cref="LaunchPadAbpSystemIntegrationServiceBase" />
+    /// <seealso cref="IAwsApiGatewayService" />
     public partial class AwsApiGatewayService : LaunchPadAbpSystemIntegrationServiceBase, IAwsApiGatewayService
     {
+        /// <summary>
+        /// Gets or sets the helper.
+        /// </summary>
+        /// <value>The helper.</value>
         public IAwsApiGatewayHelper Helper { get; set; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AwsApiGatewayService"/> class.
+        /// </summary>
         protected AwsApiGatewayService() : base()
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AwsApiGatewayService"/> class.
+        /// </summary>
+        /// <param name="logger">The logger.</param>
+        /// <param name="configurationRoot">The configuration root.</param>
+        /// <param name="regionEndpointName">Name of the region endpoint.</param>
+        /// <param name="apiGatewayBaseUri">The API gateway base URI.</param>
+        /// <param name="localAwsProfileName">Name of the local aws profile.</param>
+        /// <param name="shouldUseLocalAwsProfile">if set to <c>true</c> [should use local aws profile].</param>
         public AwsApiGatewayService(ILogger logger,
             IConfigurationRoot configurationRoot,
             string regionEndpointName,
@@ -25,6 +61,11 @@ public AwsApiGatewayService(ILogger logger,
             Helper = secretHelperFactory.Create(logger, apiGatewayBaseUri, regionEndpointName, localAwsProfileName, shouldUseLocalAwsProfile);
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AwsApiGatewayService"/> class.
+        /// </summary>
+        /// <param name="logger">The logger.</param>
+        /// <param name="helper">The helper.</param>
         public AwsApiGatewayService(ILogger logger, IAwsApiGatewayHelper helper) : base(logger)
         {
             Helper = helper;

src/Deploy.LaunchPad.AWS.Abp/Deploy.LaunchPad.AWS.Abp.csproj

@@ -10,7 +10,7 @@
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <PackageProjectUrl>https://github.com/DeploySolutions/launchpad-shared</PackageProjectUrl>
     <RepositoryUrl>https://github.com/DeploySolutions/launchpad-shared</RepositoryUrl>
-    <Version>10.0.0</Version>
+    <Version>10.0.1</Version>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
     <PackageIcon>icon.png</PackageIcon>
     <IncludeSymbols>true</IncludeSymbols>

src/Deploy.LaunchPad.AWS.Abp/ElasticFileSystem/AwsElasticFileSystemHelperFactory.cs

@@ -1,4 +1,17 @@
-using Abp.Dependency;
+// ***********************************************************************
+// Assembly         : Deploy.LaunchPad.AWS.Abp
+// Author           : Nicholas Kellett
+// Created          : 11-19-2023
+//
+// Last Modified By : Nicholas Kellett
+// Last Modified On : 01-08-2023
+// ***********************************************************************
+// <copyright file="AwsElasticFileSystemHelperFactory.cs" company="Deploy Software Solutions, inc.">
+//     2021-2023 Deploy Software Solutions, inc.
+// </copyright>
+// <summary></summary>
+// ***********************************************************************
+using Abp.Dependency;
 using Amazon;
 using Amazon.ElasticFileSystem;
 using Castle.Core.Logging;
@@ -7,14 +20,34 @@
 
 namespace Deploy.LaunchPad.AWS.Abp.ElasticFileSystem
 {
+    /// <summary>
+    /// Class AwsElasticFileSystemHelperFactory.
+    /// Implements the <see cref="Deploy.LaunchPad.AWS.AwsHelperBase{Amazon.ElasticFileSystem.AmazonElasticFileSystemConfig}" />
+    /// Implements the <see cref="ISingletonDependency" />
+    /// </summary>
+    /// <seealso cref="Deploy.LaunchPad.AWS.AwsHelperBase{Amazon.ElasticFileSystem.AmazonElasticFileSystemConfig}" />
+    /// <seealso cref="ISingletonDependency" />
     public partial class AwsElasticFileSystemHelperFactory : AwsHelperBase<AmazonElasticFileSystemConfig>, ISingletonDependency
     {
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AwsElasticFileSystemHelperFactory"/> class.
+        /// </summary>
+        /// <param name="logger">The logger.</param>
+        /// <param name="awsRegionEndpointName">Name of the aws region endpoint.</param>
         public AwsElasticFileSystemHelperFactory(ILogger logger, string awsRegionEndpointName) : base(logger, awsRegionEndpointName)
         {
 
         }
 
+        /// <summary>
+        /// Creates the specified logger.
+        /// </summary>
+        /// <param name="logger">The logger.</param>
+        /// <param name="awsRegionEndpointName">Name of the aws region endpoint.</param>
+        /// <param name="awsProfileName">Name of the aws profile.</param>
+        /// <param name="shouldUseLocalAwsProfile">if set to <c>true</c> [should use local aws profile].</param>
+        /// <returns>AwsElasticFileSystemHelper.</returns>
         public virtual AwsElasticFileSystemHelper Create(
             ILogger logger,
             string awsRegionEndpointName = DefaultRegionEndpointName,

src/Deploy.LaunchPad.AWS.Abp/ElasticFileSystem/Services/AwsElasticFileSystemService.cs

@@ -1,20 +1,55 @@
-using Castle.Core.Logging;
+// ***********************************************************************
+// Assembly         : Deploy.LaunchPad.AWS.Abp
+// Author           : Nicholas Kellett
+// Created          : 11-19-2023
+//
+// Last Modified By : Nicholas Kellett
+// Last Modified On : 03-21-2023
+// ***********************************************************************
+// <copyright file="AwsElasticFileSystemService.cs" company="Deploy Software Solutions, inc.">
+//     2021-2023 Deploy Software Solutions, inc.
+// </copyright>
+// <summary></summary>
+// ***********************************************************************
+using Castle.Core.Logging;
 using Deploy.LaunchPad.AWS.ElasticFileSystem;
 using Deploy.LaunchPad.AWS.ElasticFileSystem.Services;
 using Deploy.LaunchPad.Core.Abp.Application;
 using Microsoft.Extensions.Configuration;
 
 namespace Deploy.LaunchPad.AWS.Abp.ElasticFileSystem.Services
 {
+    /// <summary>
+    /// Class AwsElasticFileSystemService.
+    /// Implements the <see cref="LaunchPadAbpSystemIntegrationServiceBase" />
+    /// Implements the <see cref="IAwsElasticFileSystemService" />
+    /// </summary>
+    /// <seealso cref="LaunchPadAbpSystemIntegrationServiceBase" />
+    /// <seealso cref="IAwsElasticFileSystemService" />
     public partial class AwsElasticFileSystemService : LaunchPadAbpSystemIntegrationServiceBase, IAwsElasticFileSystemService
     {
 
+        /// <summary>
+        /// Gets or sets the helper.
+        /// </summary>
+        /// <value>The helper.</value>
         public IAwsElasticFileSystemHelper Helper { get; set; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AwsElasticFileSystemService"/> class.
+        /// </summary>
         protected AwsElasticFileSystemService() : base()
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AwsElasticFileSystemService"/> class.
+        /// </summary>
+        /// <param name="logger">The logger.</param>
+        /// <param name="configurationRoot">The configuration root.</param>
+        /// <param name="regionEndpointName">Name of the region endpoint.</param>
+        /// <param name="localAwsProfileName">Name of the local aws profile.</param>
+        /// <param name="shouldUseLocalAwsProfile">if set to <c>true</c> [should use local aws profile].</param>
         public AwsElasticFileSystemService(ILogger logger,
             IConfigurationRoot configurationRoot,
             string regionEndpointName,
@@ -25,6 +60,11 @@ public AwsElasticFileSystemService(ILogger logger,
             Helper = secretHelperFactory.Create(logger, regionEndpointName, localAwsProfileName, shouldUseLocalAwsProfile);
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AwsElasticFileSystemService"/> class.
+        /// </summary>
+        /// <param name="logger">The logger.</param>
+        /// <param name="helper">The helper.</param>
         public AwsElasticFileSystemService(ILogger logger, IAwsElasticFileSystemHelper helper) : base(logger)
         {
             Helper = helper;

src/Deploy.LaunchPad.AWS.Abp/Lambda/Services/AwsLambdaService.cs

@@ -1,18 +1,49 @@
-using Castle.Core.Logging;
+// ***********************************************************************
+// Assembly         : Deploy.LaunchPad.AWS.Abp
+// Author           : Nicholas Kellett
+// Created          : 11-19-2023
+//
+// Last Modified By : Nicholas Kellett
+// Last Modified On : 03-21-2023
+// ***********************************************************************
+// <copyright file="AwsLambdaService.cs" company="Deploy Software Solutions, inc.">
+//     2021-2023 Deploy Software Solutions, inc.
+// </copyright>
+// <summary></summary>
+// ***********************************************************************
+using Castle.Core.Logging;
 using Deploy.LaunchPad.AWS.Lambda;
 using Deploy.LaunchPad.AWS.Lambda.Services;
 using Deploy.LaunchPad.Core.Abp.Application;
 
 namespace Deploy.LaunchPad.AWS.Abp.Lambda.Services
 {
+    /// <summary>
+    /// Class AwsLambdaService.
+    /// Implements the <see cref="LaunchPadAbpSystemIntegrationServiceBase" />
+    /// Implements the <see cref="IAwsLambdaService" />
+    /// </summary>
+    /// <seealso cref="LaunchPadAbpSystemIntegrationServiceBase" />
+    /// <seealso cref="IAwsLambdaService" />
     public partial class AwsLambdaService : LaunchPadAbpSystemIntegrationServiceBase, IAwsLambdaService
     {
+        /// <summary>
+        /// Gets or sets the helper.
+        /// </summary>
+        /// <value>The helper.</value>
         public IAwsLambdaHelper Helper { get; set; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AwsLambdaService"/> class.
+        /// </summary>
         public AwsLambdaService() : base()
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AwsLambdaService"/> class.
+        /// </summary>
+        /// <param name="logger">The logger.</param>
         public AwsLambdaService(ILogger logger) : base(logger)
         {
 

src/Deploy.LaunchPad.AWS.Abp/Redshift/AwsRedshiftHelperFactory.cs

@@ -1,19 +1,52 @@
-using Abp.Dependency;
+// ***********************************************************************
+// Assembly         : Deploy.LaunchPad.AWS.Abp
+// Author           : Nicholas Kellett
+// Created          : 11-19-2023
+//
+// Last Modified By : Nicholas Kellett
+// Last Modified On : 01-08-2023
+// ***********************************************************************
+// <copyright file="AwsRedshiftHelperFactory.cs" company="Deploy Software Solutions, inc.">
+//     2021-2023 Deploy Software Solutions, inc.
+// </copyright>
+// <summary></summary>
+// ***********************************************************************
+using Abp.Dependency;
 using Amazon;
 using Amazon.Redshift;
 using Castle.Core.Logging;
 using Castle.MicroKernel;
 
 namespace Deploy.LaunchPad.AWS.Redshift
 {
+    /// <summary>
+    /// Class AwsRedshiftHelperFactory.
+    /// Implements the <see cref="Deploy.LaunchPad.AWS.AwsHelperBase{Amazon.Redshift.AmazonRedshiftConfig}" />
+    /// Implements the <see cref="ISingletonDependency" />
+    /// </summary>
+    /// <seealso cref="Deploy.LaunchPad.AWS.AwsHelperBase{Amazon.Redshift.AmazonRedshiftConfig}" />
+    /// <seealso cref="ISingletonDependency" />
     public partial class AwsRedshiftHelperFactory : AwsHelperBase<AmazonRedshiftConfig>, ISingletonDependency
     {
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AwsRedshiftHelperFactory"/> class.
+        /// </summary>
+        /// <param name="logger">The logger.</param>
+        /// <param name="awsRegionEndpointName">Name of the aws region endpoint.</param>
         public AwsRedshiftHelperFactory(ILogger logger, string awsRegionEndpointName) : base(logger, awsRegionEndpointName)
         {
 
         }
 
+        /// <summary>
+        /// Creates the specified logger.
+        /// </summary>
+        /// <param name="logger">The logger.</param>
+        /// <param name="awsRegionEndpointName">Name of the aws region endpoint.</param>
+        /// <param name="awsProfileName">Name of the aws profile.</param>
+        /// <param name="shouldUseLocalAwsProfile">if set to <c>true</c> [should use local aws profile].</param>
+        /// <returns>AwsRedshiftHelper.</returns>
         public virtual AwsRedshiftHelper Create(
             ILogger logger,
             string awsRegionEndpointName = DefaultRegionEndpointName,