Added xml comments for all Public facing Members and methods

Hariharan Subramanian · Hariharan Subramanian · commit 7dc82507a84b · 2019-09-18T16:06:47.000+05:30
diff --git a/Sample/ConsoleApp/Program.cs b/Sample/ConsoleApp/Program.cs
@@ -5,7 +5,7 @@
 using StackExchange.NET.Models;
 
 namespace StackExchange.NET_Example
-{	
+{
 	class Program
 	{
 		static void Main(string[] args)
@@ -17,14 +17,14 @@ static void Main(string[] args)
 				Page = 1,
 				Sort = Sort.Votes
 			};
-			var res = client.Answers.GetAllAnswers(null);
-		//	var answers = client.Answers.GetAllAnswers(queryString);
+
+			//	var answers = client.Answers.GetAllAnswers(queryString);
 			var ids = new List<string>()
 						{
 								"44164379","6841479"
 						};
 			//var answers = client.Answers.GetAnswerByIds(ids, queryString);
-			//var answers = client.Answers.GetCommentsByIds(ids, queryString);
+			//var answers = client.Answers.GetCommentsOnAnswers(ids, queryString);
 			//var answers = client.Answers.GetQuestionByAnswerIds(ids, queryString);
 
 			var badgeFilter = new BadgeFilters()
@@ -40,8 +40,8 @@ static void Main(string[] args)
 			//var getBadgesByIds = client.Badges.GetNonTaggedBadges(batchIds, badgeFilter);
 			//var getBadgesByIds = client.Badges.GetBadgesByIds(batchIds, badgeFilter);
 			//var getBadgesByIds = client.Badges.GetRecentlyAwardedBadges(badgeFilter);
-			
-		//	var getBadgesByIds = client.Badges.GetRecentlyAwardedBadgesByIds(batchIds, badgeFilter);
+
+			//	var getBadgesByIds = client.Badges.GetRecentlyAwardedBadgesByIds(batchIds, badgeFilter);
 
 			//var getBadgesByIds = client.Badges.GetAllTaggedBadges(badgeFilter);
 			//Console.WriteLine(JsonConvert.SerializeObject(getBadgesByIds));
@@ -56,7 +56,7 @@ static void Main(string[] args)
 						{
 								"102165885", "102166303"
 						};
-			//var comments = client.Comments.GetCommentsByIds(commentIds,commentFilter);
+			//var comments = client.Comments.GetCommentsOnAnswers(commentIds,commentFilter);
 			//Console.WriteLine(JsonConvert.SerializeObject(comments));
 
 			var postFilter = new PostFilter()
@@ -75,12 +75,12 @@ static void Main(string[] args)
 
 			//var postsByIds = client.Posts.GetCommentsOnPosts(postIds, postFilter);
 
-		//	var revisionByIds = client.Posts.GetRevisionsByIds(postIds, postFilter);
+			//	var revisionByIds = client.Posts.GetRevisionsByIds(postIds, postFilter);
 
-			 var suggestedEdits = client.Posts.GetSuggestedEdits(postIds, new SuggestedEditFilter()
-			 {
-			 	Sort = PostSort.Creation
-			 });
+			var suggestedEdits = client.Posts.GetSuggestedEdits(postIds, new SuggestedEditFilter()
+			{
+				Sort = PostSort.Creation
+			});
 
 			Console.WriteLine(JsonConvert.SerializeObject(suggestedEdits));
 			Console.ReadKey();
diff --git a/StackExchange.NET/StackExchange.NET/Clients/Answers.cs b/StackExchange.NET/StackExchange.NET/Clients/Answers.cs
@@ -1,6 +1,5 @@
 ﻿#region Using Directives
 
-using System;
 using System.Collections.Generic;
 using StackExchange.NET.Helpers;
 using StackExchange.NET.Interfaces;
@@ -10,8 +9,14 @@
 
 namespace StackExchange.NET.Clients
 {
+	/// <summary>
+	/// StackExchangeClient used to perform operations on APIs.
+	/// </summary>
 	public partial class StackExchangeClient : IAnswers
 	{
+		/// <summary>
+		/// The Answers interface which lists all possible operations.
+		/// </summary>
 		public IAnswers Answers => this;
 		BaseResponse<Answer> IAnswers.GetAllAnswers(AnswerFilters filters)
 		{
@@ -35,7 +40,7 @@ BaseResponse<Answer> IAnswers.GetAnswerByIds(List<string> ids, AnswerFilters fil
 			return response;
 		}
 
-		BaseResponse<Answer> IAnswers.GetCommentsByIds(List<string> ids, AnswerFilters filters)
+		BaseResponse<Answer> IAnswers.GetCommentsOnAnswers(List<string> ids, AnswerFilters filters)
 		{
 			var url = ApiUrlBuilder.Initialize(_apiKey)
 				.ForClient(ClientType.Answers)
@@ -57,54 +62,5 @@ BaseResponse<Question> IAnswers.GetQuestionByAnswerIds(List<string> ids, AnswerF
 			return response;
 		}
 
-		void IAnswers.AcceptAnAnswer(string id, AnswerFilters filters)
-		{
-			throw new NotImplementedException();
-		}
-
-		void IAnswers.UndoAcceptedAnswer(string id, AnswerFilters filters)
-		{
-			throw new NotImplementedException();
-		}
-
-		void IAnswers.DeleteAnswer(string id, AnswerFilters filters)
-		{
-			throw new NotImplementedException();
-		}
-
-		void IAnswers.DownVoteAnswer(string id, AnswerFilters filters)
-		{
-			throw new NotImplementedException();
-		}
-
-		void IAnswers.UndoDownVotedAnswer(string id, AnswerFilters filters)
-		{
-			throw new NotImplementedException();
-		}
-
-		void IAnswers.EditAnswer(string id, AnswerFilters filters)
-		{
-			throw new NotImplementedException();
-		}
-
-		void IAnswers.GetOptionsOfAnswer(string id, AnswerFilters filters)
-		{
-			throw new NotImplementedException();
-		}
-
-		void IAnswers.FlagAnswer(string id, AnswerFilters filters)
-		{
-			throw new NotImplementedException();
-		}
-
-		void IAnswers.UpVoteAnswer(string id, AnswerFilters filters)
-		{
-			throw new NotImplementedException();
-		}
-
-		void IAnswers.UndoUpVotedAnswer(string id, AnswerFilters filters)
-		{
-			throw new NotImplementedException();
-		}
 	}
 }
diff --git a/StackExchange.NET/StackExchange.NET/Clients/Badges.cs b/StackExchange.NET/StackExchange.NET/Clients/Badges.cs
@@ -11,6 +11,9 @@ namespace StackExchange.NET.Clients
 {
 	public partial class StackExchangeClient : IBadges
 	{
+		/// <summary>
+		/// The Badges interface which lists all possible operations.
+		/// </summary>
 		public IBadges Badges => this;
 
 		BaseResponse<Badge> IBadges.GetAllBadges(BadgeFilters filters, string inName)
diff --git a/StackExchange.NET/StackExchange.NET/Clients/Comments.cs b/StackExchange.NET/StackExchange.NET/Clients/Comments.cs
@@ -11,6 +11,9 @@ namespace StackExchange.NET.Clients
 {
 	public partial class StackExchangeClient : IComments
 	{
+		/// <summary>
+		/// The Comments interface which lists all possible operations.
+		/// </summary>
 		public IComments Comments => this;
 
 		BaseResponse<Comment> IComments.GetAllComments(CommentFilter filters)
diff --git a/StackExchange.NET/StackExchange.NET/Clients/PostsClient.cs b/StackExchange.NET/StackExchange.NET/Clients/PostsClient.cs
@@ -13,6 +13,9 @@ namespace StackExchange.NET.Clients
 {
 	public partial class StackExchangeClient : IPosts
 	{
+		/// <summary>
+		/// The Posts interface which lists all possible operations.
+		/// </summary>
 		public IPosts Posts => this;
 
 		BaseResponse<Post> IPosts.GetAllPosts(PostFilter filters)
diff --git a/StackExchange.NET/StackExchange.NET/Exceptions/StackExchangeApiException.cs b/StackExchange.NET/StackExchange.NET/Exceptions/StackExchangeApiException.cs
@@ -2,6 +2,9 @@
 
 namespace StackExchange.NET.Exceptions
 {
+	/// <summary>
+	/// StackExchangeApiException
+	/// </summary>
 	public class StackExchangeApiException : Exception
 	{
 		/// <summary>
diff --git a/StackExchange.NET/StackExchange.NET/Helpers/ApiUrlBuilder.cs b/StackExchange.NET/StackExchange.NET/Helpers/ApiUrlBuilder.cs
@@ -11,6 +11,10 @@ public class ApiUrlBuilder : IApiUrlHelper
 		private string _filter;
 		private readonly string _apiKey;
 
+		/// <summary>
+		/// Constructor used to Build the api url internally
+		/// </summary>
+		/// <param name="apiKey"></param>
 		public ApiUrlBuilder(string apiKey)
 		{
 			_apiKey = apiKey;
diff --git a/StackExchange.NET/StackExchange.NET/Helpers/ClientType.cs b/StackExchange.NET/StackExchange.NET/Helpers/ClientType.cs
@@ -1,5 +1,8 @@
 ﻿namespace StackExchange.NET.Helpers
 {
+	/// <summary>
+	/// The list of Interfaces exposed for consuming the API
+	/// </summary>
 	public enum ClientType
 	{
 		Answers,
diff --git a/StackExchange.NET/StackExchange.NET/Helpers/ExtensionMethods.cs b/StackExchange.NET/StackExchange.NET/Helpers/ExtensionMethods.cs
@@ -10,7 +10,7 @@ namespace StackExchange.NET.Helpers
 {
 	internal static class ExtensionMethods
 	{
-		public static string GetQueryString(this object obj)
+		internal static string GetQueryString(this object obj)
 		{
 			var properties = from p in obj.GetType().GetProperties()
 											 where p.GetValue(obj, null) != null
diff --git a/StackExchange.NET/StackExchange.NET/Helpers/MakeSure.cs b/StackExchange.NET/StackExchange.NET/Helpers/MakeSure.cs
@@ -4,6 +4,9 @@
 
 namespace StackExchange.NET.Helpers
 {
+	/// <summary>
+	/// Used for Validating parameters for Exceptions
+	/// </summary>
 	public abstract class MakeSure
 	{
 		/// <summary>Checks an argument to make sure it isn't null</summary>
diff --git a/StackExchange.NET/StackExchange.NET/Interfaces/IAnswers.cs b/StackExchange.NET/StackExchange.NET/Interfaces/IAnswers.cs
@@ -3,21 +3,45 @@
 
 namespace StackExchange.NET.Interfaces
 {
+	/// <summary>
+	/// The Answers interface which lists all possible operations.
+	/// </summary>
 	public interface IAnswers
 	{
+		/// <summary>Returns all the undeleted answers in the system.</summary>
+		/// <param name="filters">The Answer filters.</param>
+		/// <returns>This method returns a list of answers</returns>
 		BaseResponse<Answer> GetAllAnswers(AnswerFilters filters);
+		/// <summary>
+		/// Gets the set of answers identified by ids.
+		/// </summary>
+		/// <param name="ids"></param>
+		/// <param name="filters"></param>
+		/// <returns></returns>
 		BaseResponse<Answer> GetAnswerByIds(List<string> ids, AnswerFilters filters);
-		BaseResponse<Answer> GetCommentsByIds(List<string> ids, AnswerFilters filters);
+		/// <summary>
+		/// Gets the comments on a set of answers.
+		/// </summary>
+		/// <param name="ids"></param>
+		/// <param name="filters"></param>
+		/// <returns></returns>
+		BaseResponse<Answer> GetCommentsOnAnswers(List<string> ids, AnswerFilters filters);
+		/// <summary>
+		/// Returns the questions that answers identified by {ids} are on.
+		/// </summary>
+		/// <param name="ids"></param>
+		/// <param name="filters"></param>
+		/// <returns></returns>
 		BaseResponse<Question> GetQuestionByAnswerIds(List<string> ids, AnswerFilters filters);
-		void AcceptAnAnswer(string id, AnswerFilters filters);
-		void UndoAcceptedAnswer(string id, AnswerFilters filters);
-		void DeleteAnswer(string id, AnswerFilters filters);
-		void DownVoteAnswer(string id, AnswerFilters filters);
-		void UndoDownVotedAnswer(string id, AnswerFilters filters);
-		void EditAnswer(string id, AnswerFilters filters);
-		void GetOptionsOfAnswer(string id, AnswerFilters filters);
-		void FlagAnswer(string id, AnswerFilters filters);
-		void UpVoteAnswer(string id, AnswerFilters filters);
-		void UndoUpVotedAnswer(string id, AnswerFilters filters);
+		//void AcceptAnAnswer(string id, AnswerFilters filters);
+		//void UndoAcceptedAnswer(string id, AnswerFilters filters);
+		//void DeleteAnswer(string id, AnswerFilters filters);
+		//void DownVoteAnswer(string id, AnswerFilters filters);
+		//void UndoDownVotedAnswer(string id, AnswerFilters filters);
+		//void EditAnswer(string id, AnswerFilters filters);
+		//void GetOptionsOfAnswer(string id, AnswerFilters filters);
+		//void FlagAnswer(string id, AnswerFilters filters);
+		//void UpVoteAnswer(string id, AnswerFilters filters);
+		//void UndoUpVotedAnswer(string id, AnswerFilters filters);
 	}
 }
diff --git a/StackExchange.NET/StackExchange.NET/Interfaces/IBadges.cs b/StackExchange.NET/StackExchange.NET/Interfaces/IBadges.cs
@@ -3,13 +3,51 @@
 
 namespace StackExchange.NET.Interfaces
 {
+	/// <summary>
+	/// The Badges interface which lists all possible operations.
+	/// </summary>
 	public interface IBadges
 	{
+		/// <summary>
+		/// Returns all the badges in the system.
+		/// </summary>
+		/// <param name="filters"></param>
+		/// <param name="inName"></param>
+		/// <returns></returns>
 		BaseResponse<Badge> GetAllBadges(BadgeFilters filters, string inName = null);
+		/// <summary>
+		/// Gets the badges identified in id.
+		/// </summary>
+		/// <param name="ids"></param>
+		/// <param name="filters"></param>
+		/// <returns></returns>
 		BaseResponse<Badge> GetBadgesByIds(List<string> ids, BadgeFilters filters);
+		/// <summary>
+		/// Gets all explicitly named badges in the system.
+		/// </summary>
+		/// <param name="ids"></param>
+		/// <param name="filters"></param>
+		/// <returns></returns>
 		BaseResponse<Badge> GetNonTaggedBadges(List<string> ids, BadgeFilters filters);
+		/// <summary>
+		/// Returns recently awarded badges in the system.
+		/// </summary>
+		/// <param name="filters"></param>
+		/// <returns></returns>
 		BaseResponse<Badge> GetRecentlyAwardedBadges(BadgeFilters filters);
+		/// <summary>
+		/// Returns recently awarded badges in the system, constrained to a certain set of badges.
+		/// </summary>
+		/// <param name="ids"></param>
+		/// <param name="filters"></param>
+		/// <returns></returns>
 		BaseResponse<Badge> GetRecentlyAwardedBadgesByIds(List<string> ids, BadgeFilters filters);
+		/// <summary>
+		/// Returns the badges that are awarded for participation in specific tags.
+		/// </summary>
+		/// <param name="filters"></param>
+		/// <param name="inName"></param>
+		/// <returns></returns>
 		BaseResponse<Badge> GetAllTaggedBadges(BadgeFilters filters, string inName = null);
 	}
 }
diff --git a/StackExchange.NET/StackExchange.NET/Interfaces/IComments.cs b/StackExchange.NET/StackExchange.NET/Interfaces/IComments.cs
@@ -3,9 +3,23 @@
 
 namespace StackExchange.NET.Interfaces
 {
+	/// <summary>
+	/// The Comments interface which lists all possible operations.
+	/// </summary>
 	public interface IComments
 	{
+		/// <summary>
+		/// Gets all the comments on the site
+		/// </summary>
+		/// <param name="commentFilter"></param>
+		/// <returns></returns>
 		BaseResponse<Comment> GetAllComments(CommentFilter commentFilter);
+		/// <summary>
+		/// Gets the comments identified in id.
+		/// </summary>
+		/// <param name="commentIds"></param>
+		/// <param name="commentFilter"></param>
+		/// <returns></returns>
 		BaseResponse<Comment> GetCommentsByIds(List<string> commentIds, CommentFilter commentFilter);
 	}
 }
diff --git a/StackExchange.NET/StackExchange.NET/Interfaces/IPosts.cs b/StackExchange.NET/StackExchange.NET/Interfaces/IPosts.cs
diff --git a/StackExchange.NET/StackExchange.NET/Interfaces/IQuestions.cs b/StackExchange.NET/StackExchange.NET/Interfaces/IQuestions.cs
diff --git a/StackExchange.NET/StackExchange.NET/Models/Questions.cs b/StackExchange.NET/StackExchange.NET/Models/Questions.cs
diff --git a/StackExchange.NET/StackExchange.NET/StackExchange.NET.csproj b/StackExchange.NET/StackExchange.NET/StackExchange.NET.csproj
diff --git a/StackExchange.NET/StackExchange.NET/StackExchange.NET.xml b/StackExchange.NET/StackExchange.NET/StackExchange.NET.xml

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,9 @@ namespace StackExchange.NET.Clients`
`11`	`11`	`{`
`12`	`12`	`public partial class StackExchangeClient : IBadges`
`13`	`13`	`{`
	`14`	`+ /// <summary>`
	`15`	`+ /// The Badges interface which lists all possible operations.`
	`16`	`+ /// </summary>`
`14`	`17`	`public IBadges Badges => this;`
`15`	`18`
`16`	`19`	`BaseResponse<Badge> IBadges.GetAllBadges(BadgeFilters filters, string inName)`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,9 @@ namespace StackExchange.NET.Clients`
`13`	`13`	`{`
`14`	`14`	`public partial class StackExchangeClient : IPosts`
`15`	`15`	`{`
	`16`	`+ /// <summary>`
	`17`	`+ /// The Posts interface which lists all possible operations.`
	`18`	`+ /// </summary>`
`16`	`19`	`public IPosts Posts => this;`
`17`	`20`
`18`	`21`	`BaseResponse<Post> IPosts.GetAllPosts(PostFilter filters)`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace StackExchange.NET.Exceptions`
`4`	`4`	`{`
	`5`	`+ /// <summary>`
	`6`	`+ /// StackExchangeApiException`
	`7`	`+ /// </summary>`
`5`	`8`	`public class StackExchangeApiException : Exception`
`6`	`9`	`{`
`7`	`10`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
`1`	`1`	`namespace StackExchange.NET.Helpers`
`2`	`2`	`{`
	`3`	`+ /// <summary>`
	`4`	`+ /// The list of Interfaces exposed for consuming the API`
	`5`	`+ /// </summary>`
`3`	`6`	`public enum ClientType`
`4`	`7`	`{`
`5`	`8`	`Answers,`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ namespace StackExchange.NET.Helpers`
`10`	`10`	`{`
`11`	`11`	`internal static class ExtensionMethods`
`12`	`12`	`{`
`13`		`- public static string GetQueryString(this object obj)`
	`13`	`+ internal static string GetQueryString(this object obj)`
`14`	`14`	`{`
`15`	`15`	`var properties = from p in obj.GetType().GetProperties()`
`16`	`16`	`where p.GetValue(obj, null) != null`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,9 @@`
`4`	`4`
`5`	`5`	`namespace StackExchange.NET.Helpers`
`6`	`6`	`{`
	`7`	`+ /// <summary>`
	`8`	`+ /// Used for Validating parameters for Exceptions`
	`9`	`+ /// </summary>`
`7`	`10`	`public abstract class MakeSure`
`8`	`11`	`{`
`9`	`12`	`/// <summary>Checks an argument to make sure it isn't null</summary>`