added documentaion for rating repository

2 files changed, 22 insertions, 1 deletions

diff --git a/src/Data/DevHive.Data/Repositories/RatingRepository.cs b/src/Data/DevHive.Data/Repositories/RatingRepository.cs
index 1784144..e4a5d5d 100644
--- a/src/Data/DevHive.Data/Repositories/RatingRepository.cs
+++ b/src/Data/DevHive.Data/Repositories/RatingRepository.cs
@@ -27,6 +27,11 @@ namespace DevHive.Data.Repositories
 				.Include(x => x.Post)
 				.FirstOrDefaultAsync(x => x.Id == id);
 		}
+		/// <summary>
+		/// Gets all the ratings for a psot.
+		/// </summary>
+		/// <param name="postId">Id of the post.</param>
+		/// <returns></returns>
 		public async Task<List<Rating>> GetRatingsByPostId(Guid postId)
 		{
 			return await this._context.Rating
@@ -34,12 +39,24 @@ namespace DevHive.Data.Repositories
 				.Include(x => x.Post)
 				.Where(x => x.Post.Id == postId).ToListAsync();
 		}
+		/// <summary>
+		/// Checks if a user rated a given post.
+		/// </summary>
+		/// <param name="userId">Id of the user.</param>
+		/// <param name="postId">Id of the psot.</param>
+		/// <returns>True if the user has already rated the post and false if he hasn't.</returns>
 		public async Task<bool> UserRatedPost(Guid userId, Guid postId)
 		{
 			return await this._context.Rating
 				.Where(x => x.Post.Id == postId)
 				.AnyAsync(x => x.User.Id == userId);
 		}
+		/// <summary>
+		/// Gets a rating by the post to which the rating corresponds and the user who created it.
+		/// </summary>
+		/// <param name="userId">Id of the user.</param>
+		/// <param name="postId">Id of the post.</param>
+		/// <returns>Rating for the given post by the given user.</returns>
 		public async Task<Rating> GetRatingByUserAndPostId(Guid userId, Guid postId)
 		{
 			return await this._context.Rating
@@ -48,6 +65,11 @@ namespace DevHive.Data.Repositories
 				.FirstOrDefaultAsync(x => x.Post.Id == postId && x.User.Id == userId);
 		}
 
+		/// <summary>
+		/// Checks if a given rating already exist
+		/// </summary>
+		/// <param name="id">Id of the rating</param>
+		/// <returns>True if the rating exists and false if it does not.</returns>
 		public async Task<bool> DoesRatingExist(Guid id)
 		{
 			return await this._context.Rating
diff --git a/src/Web/DevHive.Web/Startup.cs b/src/Web/DevHive.Web/Startup.cs
index 40f674d..1c714ec 100644
--- a/src/Web/DevHive.Web/Startup.cs
+++ b/src/Web/DevHive.Web/Startup.cs
@@ -5,7 +5,6 @@ using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using DevHive.Web.Configurations.Extensions;
 using Newtonsoft.Json;
-using System.Threading.Tasks;
 
 namespace DevHive.Web
 {