Made small adjustments to the documentation

Author: anthoncastillo

Chirp/src/Chirp.Core/AuthorService.cs

@@ -27,8 +27,8 @@ public interface IAuthorService
     /// </summary>
     /// <param name="userWhoFollow">username</param>
     /// <param name="userToFollow">username</param>
-    /// <returns>True if the follow went through, false if there is a follow connection between the two users</returns>
-    /// <exception cref="UserDoesNotExist">Thrown if a one of the users doesn't exist</exception>
+    /// <returns>True if the follow went through, false if there already exists a follow connection between the two users</returns>
+    /// <exception cref="UserDoesNotExist">Thrown if one of the users doesn't exist</exception>
     /// <exception cref="ArgumentException">Thrown if the value of <paramref name="userWhoFollow"/> is equal to <paramref name="userToFollow"/>.
     /// </exception>
     public bool Follow(string userWhoFollow, string userToFollow);
@@ -39,7 +39,7 @@ public interface IAuthorService
     /// <param name="userWhoFollows">username</param>
     /// <param name="userToUnFollow">username</param>
     /// <returns>True if the unfollow went through, false if there isn't a follow connection between the two users</returns>
-    /// <exception cref="UserDoesNotExist">Thrown if a one of the users doesn't exist</exception>
+    /// <exception cref="UserDoesNotExist">Thrown if one of the users doesn't exist</exception>
     /// <exception cref="ArgumentException">Thrown if the value of <paramref name="userWhoFollows"/> is equal to <paramref name="userToUnFollow"/>.
     /// </exception>
     public bool Unfollow(string userWhoFollows, string userToUnFollow);

Chirp/src/Chirp.Core/CheepService.cs

@@ -12,7 +12,7 @@ public interface ICheepService
     /// </summary>
     /// <param name="page">if it's less than or equal to zero, It's treated as 1</param>
     /// <param name="pageSize">how many cheeps are on a page. Must be greater than zero</param>
-    /// <exception cref="ArgumentOutOfRangeException">Thrown if the <paramref name="pageSize"/> less than one</exception>
+    /// <exception cref="ArgumentOutOfRangeException">Thrown if the <paramref name="pageSize"/> is less than one</exception>
     public IEnumerable<CheepDTO> GetCheepsByPage(int page, int pageSize);
 
     /// <summary>
@@ -21,7 +21,7 @@ public interface ICheepService
     /// <param name="usernames"></param>
     /// <param name="page">if it's less than or equal to zero, It's treated as 1</param>
     /// <param name="pageSize">how many cheeps are on a page. Must be greater than zero</param>
-    /// <exception cref="ArgumentOutOfRangeException">Thrown if the <paramref name="pageSize"/> less than one</exception>
+    /// <exception cref="ArgumentOutOfRangeException">Thrown if the <paramref name="pageSize"/> is less than one</exception>
     public IEnumerable<CheepDTO> GetCheepsFromAuthorsByPage(IEnumerable<string> usernames, int page, int pageSize);
 
     /// <summary>
@@ -31,22 +31,20 @@ public interface ICheepService
     public IEnumerable<CheepDTO> GetCheepsFromAuthor(string username);
 
     /// <summary>
-    /// Gets the amount of pages that are needed to display all the cheeps in the database,
-    /// given the page size
+    /// Gets the amount of pages cheeped by an author with a given page size
     /// </summary>
     /// <param name="pageSize">how many cheeps are on a page. Must be greater than zero</param>
     /// <returns>The result is rounded to the next larger int</returns>
-    /// <exception cref="ArgumentOutOfRangeException">Thrown if the <paramref name="pageSize"/> less than one</exception>
+    /// <exception cref="ArgumentOutOfRangeException">Thrown if the <paramref name="pageSize"/> is less than one</exception>
     public int GetAmountOfCheepPages(int pageSize);
 
     /// <summary>
-    /// Gets the amount of pages that are needed author to display all Cheeps made by the given authors,
-    /// given the page size
+    /// Gets the amount of pages cheeped by a collection of authors with a given page size
     /// </summary>
     /// <param name="usernames">the usernames of the authors</param>
     /// <param name="pageSize">how many cheeps are on a page. Must be greater than zero</param>
     /// <returns>the result is rounded to the next larger int</returns>
-    /// <exception cref="ArgumentOutOfRangeException">Thrown if the <paramref name="pageSize"/> less than one</exception>
+    /// <exception cref="ArgumentOutOfRangeException">Thrown if the <paramref name="pageSize"/> is less than one</exception>
     public int GetAmountOfCheepPagesFromAuthors(IEnumerable<string> usernames, int pageSize);
 
     /// <summary>
@@ -61,26 +59,26 @@ public interface ICheepService
     /// Creates a new comment from the given CommentDTO
     /// </summary>
     /// <param name="comment"></param>
-    /// <returns>True if a comment vas successfully created,
+    /// <returns>True if a comment was successfully created,
     /// false if either the author said to have created the comment,
     /// or the cheep said to have been commented, doesn't exist</returns>
     public bool CreateComment(CommentDTO comment);
 
     /// <summary>
-    /// Gets the amount of Comments associated with the cheep that has the given CheepID
+    /// Gets the amount of Comments associated with the cheep that has the given CheepId
     /// </summary>
     /// <param name="cheepId"></param>
     /// <returns>If <paramref name="cheepId"/> is null, 0 is returned</returns>
     public int GetCommentAmountOnCheep(int? cheepId);
 
     /// <summary>
-    /// Gets the Cheep associated with the given CheepID
+    /// Gets the Cheep associated with the given CheepId
     /// </summary>
     /// <param name="cheepId"></param>
     public CheepDTO GetCheepFromId(int cheepId);
 
     /// <summary>
-    /// Gets all Comments associated with the cheep that has the given CheepID
+    /// Gets all Comments associated with the cheep that has the given CheepId
     /// </summary>
     /// <param name="cheepId"></param>
     public IEnumerable<CommentDTO> GetCommentsFromCheep(int cheepId);
@@ -104,14 +102,14 @@ public interface ICheepService
     public bool UnlikeCheep(LikeDTO like);
 
     /// <summary>
-    /// Gets how many Likes are associated with some Cheep given the CheepID
+    /// Gets how many Likes are associated with some Cheep given the CheepId
     /// </summary>
     /// <param name="cheepId"></param>
     /// <returns>0 if there isn't a cheep associated with the given <paramref name="cheepId"/></returns>
     public Task<int> GetLikeCount(int cheepId);
 
     /// <summary>
-    /// Returns whether an author with the given usernames has liked the cheep with the given CheepID
+    /// Returns whether an author with the given username has liked the cheep with the given CheepId
     /// </summary>
     /// <param name="cheepId"></param>
     /// <param name="username"></param>

Chirp/src/Chirp.Core/DTO/CheepDTO.cs

@@ -1,6 +1,6 @@
 namespace Chirp.Core.DTO;
 /// <summary>
-/// The CheepDTO class transfors information about Cheeps from the CheepRepository to the UI
+/// The CheepDTO class transfers information about Cheeps from the CheepRepository to the UI
 /// </summary>
 
 public class CheepDTO(int? id, string author, string message, long unixTimestamp)

Chirp/src/Chirp.Core/IAuthorRepository.cs

@@ -6,7 +6,7 @@ namespace Chirp.Core;
 public interface IAuthorRepository
 {
     /// <summary>
-    /// Gets all authors with one of the given usernames
+    /// Gets all authors by their given usernames
     /// </summary>
     /// <param name="usernames"></param>
     public Task<IEnumerable<AuthorDTO?>> GetAuthorsByNames(IEnumerable<string> usernames);
@@ -31,7 +31,7 @@ public interface IAuthorRepository
     /// <param name="userWhoFollow">username</param>
     /// <param name="userToFollow">username</param>
     /// <returns>True if the follow went through, false if there is a follow connection between the two users</returns>
-    /// <exception cref="UserDoesNotExist">Thrown if a one of the users doesn't exist</exception>
+    /// <exception cref="UserDoesNotExist">Thrown if one of the users doesn't exist</exception>
     /// <exception cref="ArgumentException">Thrown if the value of <paramref name="userWhoFollow"/> is equal to <paramref name="userToFollow"/>.
     /// </exception>
     public Task<bool> Follow(string userWhoFollow, string userToFollow);
@@ -42,7 +42,7 @@ public interface IAuthorRepository
     /// <param name="userWhoFollows">username</param>
     /// <param name="userToUnFollow">username</param>
     /// <returns>True if the unfollow went through, false if there isn't a follow connection between the two users</returns>
-    /// <exception cref="UserDoesNotExist">Thrown if a one of the users doesn't exist</exception>
+    /// <exception cref="UserDoesNotExist">Thrown if one of the users doesn't exist</exception>
     /// <exception cref="ArgumentException">Thrown if the value of <paramref name="userWhoFollows"/> is equal to <paramref name="userToUnFollow"/>.
     /// </exception>
     public Task<bool> UnFollow(string userWhoFollows, string userToUnFollow);

Chirp/src/Chirp.Core/ICheepRepository.cs

@@ -8,9 +8,9 @@ public interface ICheepRepository
     /// <summary>
     /// Gets all Cheeps on the given page by the given page size
     /// </summary>
-    /// <param name="page">if it's less than or equal to zero, It's treated as 1</param>
+    /// <param name="page">if it's less than or equal to zero, it's treated as 1</param>
     /// <param name="pageSize">how many cheeps are on a page. Must be greater than zero</param>
-    /// <exception cref="ArgumentOutOfRangeException">Thrown if the <paramref name="pageSize"/> less than one</exception>
+    /// <exception cref="ArgumentOutOfRangeException">Thrown if the <paramref name="pageSize"/> is less than one</exception>
     public Task<IEnumerable<CheepDTO>?> GetCheepsByPage(int page, int pageSize);
 
     /// <summary>
@@ -23,9 +23,9 @@ public interface ICheepRepository
     /// Gets Cheeps made by some authors with one of the given usernames by the given page and page size
     /// </summary>
     /// <param name="usernames"></param>
-    /// <param name="page">if it's less than or equal to zero, It's treated as 1</param>
+    /// <param name="page">if it's less than or equal to zero, it's treated as 1</param>
     /// <param name="pageSize">how many cheeps are on a page. Must be greater than zero</param>
-    /// <exception cref="ArgumentOutOfRangeException">Thrown if the <paramref name="pageSize"/> less than one</exception>
+    /// <exception cref="ArgumentOutOfRangeException">Thrown if the <paramref name="pageSize"/> is less than one</exception>
     public Task<IEnumerable<CheepDTO>>
         GetCheepsFromAuthorsByPage(IEnumerable<string> usernames, int page, int pageSize);
 
@@ -44,7 +44,7 @@ public Task<IEnumerable<CheepDTO>>
     public Task<int> GetAmountOfCheeps();
 
     /// <summary>
-    /// Gets the amount Cheeps made by the Authors with of the given usernames
+    /// Gets the amount Cheeps made by the Authors by the given usernames
     /// </summary>
     /// <param name="usernames"></param>
     public Task<int> GetAmountOfCheepsFromAuthors(IEnumerable<string> usernames);
@@ -53,26 +53,26 @@ public Task<IEnumerable<CheepDTO>>
     /// Creates a new comment from the given CommentDTO
     /// </summary>
     /// <param name="comment"></param>
-    /// <returns>True if a comment vas successfully created,
+    /// <returns>True if a comment was successfully created,
     /// false if either the author said to have created the comment,
     /// or the cheep said to have been commented, doesn't exist</returns>
     public Task<bool> CreateComment(CommentDTO comment);
 
     /// <summary>
-    /// Gets the amount of Comments associated with the cheep that has the given CheepID
+    /// Gets the amount of Comments associated with the cheep that has the given CheepId
     /// </summary>
     /// <param name="cheepId"></param>
     /// <returns>If <paramref name="cheepId"/> is null, 0 is returned</returns>
     public Task<int> GetCommentAmountOnCheep(int? cheepId);
 
     /// <summary>
-    /// Gets the Cheep associated with the given CheepID
+    /// Gets the Cheep associated with the given CheepId
     /// </summary>
     /// <param name="cheepId"></param>
     public Task<CheepDTO> GetCheepById(int cheepId);
 
     /// <summary>
-    /// Gets all Comments associated with the cheep that has the given CheepID
+    /// Gets all Comments associated with the cheep that has the given CheepId
     /// </summary>
     /// <param name="cheepId"></param>
     public Task<IEnumerable<CommentDTO>> GetCommentsForCheep(int cheepId);
@@ -96,14 +96,14 @@ public Task<IEnumerable<CheepDTO>>
     public Task<bool> UnlikeCheep(LikeDTO like);
 
     /// <summary>
-    /// Gets how many Likes are associated with some Cheep given the CheepID
+    /// Gets how many Likes are associated with some Cheep given the CheepId
     /// </summary>
     /// <param name="cheepId"></param>
     /// <returns>0 if there isn't a cheep associated with the given <paramref name="cheepId"/></returns>
     Task<int> GetLikeCount(int cheepId);
 
     /// <summary>
-    /// Returns whether an author with the given usernames has liked the cheep with the given CheepID
+    /// Returns whether an author with the given username has liked the cheep with the given CheepId
     /// </summary>
     /// <param name="cheepId"></param>
     /// <param name="username"></param>

Chirp/src/Chirp.Infrastructure/Model/Author.cs

@@ -4,8 +4,8 @@
 namespace Chirp.Infrastructure.Model;
 /// <summary>
 /// The Author class acts as the User for the Chirp! program
-/// an author is able to Cheep, Comment on Cheeps, like Cheeps
-/// and follow other Authors
+/// where an author is able to Create, Comment and/or Like Cheeps
+/// or Follow other Authors
 /// </summary>
 public sealed class Author : IdentityUser
 {
@@ -33,8 +33,8 @@ public static Author CreateAuthor(AuthorDTO author)
     /// </summary>
     /// <param name="username"></param>
     /// <param name="email"></param>
-    /// <returns></returns>
-    /// <exception cref="ArgumentNullException"></exception>
+    /// <returns>Returns the created Author with the given username and email</returns>
+    /// <exception cref="ArgumentNullException">Thrown to specify that a username or email cannot be null</exception>
     public static Author CreateAuthor(string username, string email)
     {
         _ = username ?? throw new ArgumentNullException(nameof(username));

Chirp/src/Chirp.Infrastructure/Model/Cheep.cs

@@ -2,9 +2,8 @@
 
 namespace Chirp.Infrastructure.Model;
 /// <summary>
-/// The Cheep class, represent a cheep, which is a small 160-character message that can
-/// be published by authors on the Chirp! platform,
-/// as well as commented and liked by authors
+/// The Cheep class represents the functionality of a Cheep; a 160-character long message that can be posted on the Chirp! application by a given Author.
+/// The Cheep can also be commented on and liked by an Author
 /// </summary>
 public class Cheep
 {