From 418c04807eae6220ef609a8c208d67c08cf7f723 Mon Sep 17 00:00:00 2001
From: transtrike <transtrike@gmail.com>
Date: Sun, 28 Mar 2021 21:58:50 +0300
Subject: Added profile picture documentation

---
 .../Interfaces/IProfilePictureService.cs                | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

(limited to 'src/Services/DevHive.Services/Interfaces/IProfilePictureService.cs')

diff --git a/src/Services/DevHive.Services/Interfaces/IProfilePictureService.cs b/src/Services/DevHive.Services/Interfaces/IProfilePictureService.cs
index b0673ac..c455831 100644
--- a/src/Services/DevHive.Services/Interfaces/IProfilePictureService.cs
+++ b/src/Services/DevHive.Services/Interfaces/IProfilePictureService.cs
@@ -6,17 +6,32 @@ namespace DevHive.Services.Interfaces
 {
 	public interface IProfilePictureService
 	{
+		/// <summary>
+		/// Inserts a user's profile picture in the database and cloud
+		/// </summary>
+		/// <param name="profilePictureServiceModel">User's Guid and his/hers profile picture as file</param>
+		/// <returns>The new profile picture's URL in the cloud</returns>
 		Task<string> InsertProfilePicture(ProfilePictureServiceModel profilePictureServiceModel);
 
+		/// <summary>
+		/// Get a profile picture by it's Guid
+		/// </summary>
+		/// <param name="id">Profile picture's Guid</param>
+		/// <returns>The profile picture's URL in the cloud</returns>
 		Task<string> GetProfilePictureById(Guid id);
 
 		/// <summary>
 		/// Uploads the given picture and assigns it's link to the user in the database
 		/// </summary>
 		/// <param name="profilePictureServiceModel">Contains User's Guid and the new picture to be updated</param>
-		/// <returns>The new picture's URL</returns>
+		/// <returns>The new profile picture's URL in the cloud</returns>
 		Task<string> UpdateProfilePicture(ProfilePictureServiceModel profilePictureServiceModel);
 
+		/// <summary>
+		/// Delete a profile picture from the cloud and the database
+		/// </summary>
+		/// <param name="id">The profile picture's Guid</param>
+		/// <returns>True if the picture is deleted, false otherwise</returns>
 		Task<bool> DeleteProfilePicture(Guid id);
 	}
 }
-- 
cgit v1.2.3