chore: organize the summary comments

nixhantb · Mar 18, 2024 · 35288bf · 35288bf
1 parent 53ac1da
commit 35288bf
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 3 deletions.
diff --git a/JobLeet.WebApi/JobLeet.Infrastructure/Repositories/Common/V1/EmailTypeRepository.cs b/JobLeet.WebApi/JobLeet.Infrastructure/Repositories/Common/V1/EmailTypeRepository.cs
@@ -7,12 +7,19 @@ namespace JobLeet.WebApi.JobLeet.Infrastructure.Repositories.Common.V1
 {
     public class EmailTypeRepository : IEmaiTypeRepository 
     {
+        #region Initialization
+        // <returns>The list of initializations</returns>
         private readonly BaseDBContext _dbContext;
-
         public EmailTypeRepository(BaseDBContext dbContext)
         {
             _dbContext = dbContext;
         }
+        #endregion
+
+        #region Retrieve EmailTypes Asynchronously By ID
+        /// <returns>The list of email-types by Id.</returns>
+        /// <exception cref="Exception">Thrown when there is an error while fetching data from the database.</exception>
+        /// <remarks>This method fetches all email-types by Id from the database using Entity Framework Core.</remarks>
         public async Task<EmailModel> GetByIdAsync(int id)
        {
            try
@@ -33,7 +40,12 @@ public async Task<EmailModel> GetByIdAsync(int id)
             throw new Exception($"Error occurred while fetching email with id {id}: {ex.Message}");
         }
     }
+        #endregion
 
+        #region Retrieve EmailTypes Asynchronously
+        /// <returns>The list of email-types.</returns>
+        /// <exception cref="Exception">Thrown when there is an error while fetching data from the database.</exception>
+        /// <remarks>This method fetches all email-types from the database using Entity Framework Core.</remarks>
         public async Task<List<EmailModel>> GetAllAsync()
         {
             try
@@ -52,6 +64,7 @@ public async Task<List<EmailModel>> GetAllAsync()
                 throw new Exception("Error while fetching the database. Please try again later."+ex.Message);
             }
         }
+        #endregion
 
         public Task AddAsync(EmailModel emailType)
         {

diff --git a/JobLeet.WebApi/JobLeet.Infrastructure/Repositories/Common/V1/PersonNameRepository.cs b/JobLeet.WebApi/JobLeet.Infrastructure/Repositories/Common/V1/PersonNameRepository.cs
@@ -11,11 +11,14 @@ namespace JobLeet.WebApi.JobLeet.Infrastructure.Repositories.Common.V1
 {
     public class PersonNameRepository : IPersonNameRepository
     {
+        #region Initialization
+        // <returns>The list of initializations</returns>
         private readonly BaseDBContext _dbContext;
         public PersonNameRepository(BaseDBContext dbContext)
         {
             _dbContext = dbContext;
         }
+        #endregion
 
         #region Retrieve Person Asynchronously
         /// <returns>The list of person names.</returns>
@@ -42,7 +45,6 @@ public async Task<List<PersonNameModel>> GetAllAsync()
         }
         #endregion
 
-
         #region Retrieve Person ID Asynchronously
         /// <returns>The list of person names by ID.</returns>
         /// <exception cref="Exception">Thrown when there is an error while fetching data from the database.</exception>

diff --git a/JobLeet.WebApi/JobLeet.Infrastructure/Repositories/Common/V1/SkillRepository.cs b/JobLeet.WebApi/JobLeet.Infrastructure/Repositories/Common/V1/SkillRepository.cs
@@ -7,12 +7,19 @@ namespace JobLeet.WebApi.JobLeet.Infrastructure.Repositories.Common.V1
 {
     public class SkillRepository : ISkillRepository
     {
+        #region Initialization
+        // <returns>The list of initializations</returns>
         private readonly BaseDBContext _dbContext;
-
         public SkillRepository(BaseDBContext dbContext)
         {
             _dbContext = dbContext;
         }
+        #endregion
+
+        #region Retrieve SkillModel Asynchronously
+        /// <returns>The list of skill-models by Id.</returns>
+        /// <exception cref="Exception">Thrown when there is an error while fetching data from the database.</exception>
+        /// <remarks>This method fetches Skill Model from the database using Entity Framework Core.</remarks>
         public async Task<List<SkillModel>> GetAllAsync()
         {
             try
@@ -31,11 +38,17 @@ public async Task<List<SkillModel>> GetAllAsync()
                 throw new Exception("Error while updating the database. Please try again later."+ex.Message);
             }
         }
+        #endregion
 
+        #region Retrieve skill-models Asynchronously By ID
+        /// <returns>The list of email-types by Id.</returns>
+        /// <exception cref="Exception">Thrown when there is an error while fetching data from the database.</exception>
+        /// <remarks>This method fetches all skill-models by Id from the database using Entity Framework Core.</remarks>
         public Task<SkillModel> GetByIdAsync(int id)
         {
             throw new NotImplementedException();
         }
+        #endregion
         public Task AddAsync(SkillModel entity)
         {
             throw new NotImplementedException();