Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 7dc8250

Browse files
author
Hariharan Subramanian
committed
Added xml comments for all Public facing Members and methods
1 parent f4b2e24 commit 7dc8250

File tree

18 files changed

+449
-75
lines changed

18 files changed

+449
-75
lines changed

‎Sample/ConsoleApp/Program.cs‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
using StackExchange.NET.Models;
66

77
namespace StackExchange.NET_Example
8-
{
8+
{
99
class Program
1010
{
1111
static void Main(string[] args)
@@ -17,14 +17,14 @@ static void Main(string[] args)
1717
Page = 1,
1818
Sort = Sort.Votes
1919
};
20-
varres=client.Answers.GetAllAnswers(null);
21-
// var answers = client.Answers.GetAllAnswers(queryString);
20+
21+
// var answers = client.Answers.GetAllAnswers(queryString);
2222
var ids = new List<string>()
2323
{
2424
"44164379","6841479"
2525
};
2626
//var answers = client.Answers.GetAnswerByIds(ids, queryString);
27-
//var answers = client.Answers.GetCommentsByIds(ids, queryString);
27+
//var answers = client.Answers.GetCommentsOnAnswers(ids, queryString);
2828
//var answers = client.Answers.GetQuestionByAnswerIds(ids, queryString);
2929

3030
var badgeFilter = new BadgeFilters()
@@ -40,8 +40,8 @@ static void Main(string[] args)
4040
//var getBadgesByIds = client.Badges.GetNonTaggedBadges(batchIds, badgeFilter);
4141
//var getBadgesByIds = client.Badges.GetBadgesByIds(batchIds, badgeFilter);
4242
//var getBadgesByIds = client.Badges.GetRecentlyAwardedBadges(badgeFilter);
43-
44-
// var getBadgesByIds = client.Badges.GetRecentlyAwardedBadgesByIds(batchIds, badgeFilter);
43+
44+
// var getBadgesByIds = client.Badges.GetRecentlyAwardedBadgesByIds(batchIds, badgeFilter);
4545

4646
//var getBadgesByIds = client.Badges.GetAllTaggedBadges(badgeFilter);
4747
//Console.WriteLine(JsonConvert.SerializeObject(getBadgesByIds));
@@ -56,7 +56,7 @@ static void Main(string[] args)
5656
{
5757
"102165885", "102166303"
5858
};
59-
//var comments = client.Comments.GetCommentsByIds(commentIds,commentFilter);
59+
//var comments = client.Comments.GetCommentsOnAnswers(commentIds,commentFilter);
6060
//Console.WriteLine(JsonConvert.SerializeObject(comments));
6161

6262
var postFilter = new PostFilter()
@@ -75,12 +75,12 @@ static void Main(string[] args)
7575

7676
//var postsByIds = client.Posts.GetCommentsOnPosts(postIds, postFilter);
7777

78-
// var revisionByIds = client.Posts.GetRevisionsByIds(postIds, postFilter);
78+
// var revisionByIds = client.Posts.GetRevisionsByIds(postIds, postFilter);
7979

80-
var suggestedEdits = client.Posts.GetSuggestedEdits(postIds, new SuggestedEditFilter()
81-
{
82-
Sort = PostSort.Creation
83-
});
80+
var suggestedEdits = client.Posts.GetSuggestedEdits(postIds, new SuggestedEditFilter()
81+
{
82+
Sort = PostSort.Creation
83+
});
8484

8585
Console.WriteLine(JsonConvert.SerializeObject(suggestedEdits));
8686
Console.ReadKey();
Lines changed: 7 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
#region Using Directives
22

3-
using System;
43
using System.Collections.Generic;
54
using StackExchange.NET.Helpers;
65
using StackExchange.NET.Interfaces;
@@ -10,8 +9,14 @@
109

1110
namespace StackExchange.NET.Clients
1211
{
12+
/// <summary>
13+
/// StackExchangeClient used to perform operations on APIs.
14+
/// </summary>
1315
public partial class StackExchangeClient : IAnswers
1416
{
17+
/// <summary>
18+
/// The Answers interface which lists all possible operations.
19+
/// </summary>
1520
public IAnswers Answers => this;
1621
BaseResponse<Answer> IAnswers.GetAllAnswers(AnswerFilters filters)
1722
{
@@ -35,7 +40,7 @@ BaseResponse<Answer> IAnswers.GetAnswerByIds(List<string> ids, AnswerFilters fil
3540
return response;
3641
}
3742

38-
BaseResponse<Answer> IAnswers.GetCommentsByIds(List<string> ids, AnswerFilters filters)
43+
BaseResponse<Answer> IAnswers.GetCommentsOnAnswers(List<string> ids, AnswerFilters filters)
3944
{
4045
var url = ApiUrlBuilder.Initialize(_apiKey)
4146
.ForClient(ClientType.Answers)
@@ -57,54 +62,5 @@ BaseResponse<Question> IAnswers.GetQuestionByAnswerIds(List<string> ids, AnswerF
5762
return response;
5863
}
5964

60-
void IAnswers.AcceptAnAnswer(string id, AnswerFilters filters)
61-
{
62-
throw new NotImplementedException();
63-
}
64-
65-
void IAnswers.UndoAcceptedAnswer(string id, AnswerFilters filters)
66-
{
67-
throw new NotImplementedException();
68-
}
69-
70-
void IAnswers.DeleteAnswer(string id, AnswerFilters filters)
71-
{
72-
throw new NotImplementedException();
73-
}
74-
75-
void IAnswers.DownVoteAnswer(string id, AnswerFilters filters)
76-
{
77-
throw new NotImplementedException();
78-
}
79-
80-
void IAnswers.UndoDownVotedAnswer(string id, AnswerFilters filters)
81-
{
82-
throw new NotImplementedException();
83-
}
84-
85-
void IAnswers.EditAnswer(string id, AnswerFilters filters)
86-
{
87-
throw new NotImplementedException();
88-
}
89-
90-
void IAnswers.GetOptionsOfAnswer(string id, AnswerFilters filters)
91-
{
92-
throw new NotImplementedException();
93-
}
94-
95-
void IAnswers.FlagAnswer(string id, AnswerFilters filters)
96-
{
97-
throw new NotImplementedException();
98-
}
99-
100-
void IAnswers.UpVoteAnswer(string id, AnswerFilters filters)
101-
{
102-
throw new NotImplementedException();
103-
}
104-
105-
void IAnswers.UndoUpVotedAnswer(string id, AnswerFilters filters)
106-
{
107-
throw new NotImplementedException();
108-
}
10965
}
11066
}

‎StackExchange.NET/StackExchange.NET/Clients/Badges.cs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ namespace StackExchange.NET.Clients
1111
{
1212
public partial class StackExchangeClient : IBadges
1313
{
14+
/// <summary>
15+
/// The Badges interface which lists all possible operations.
16+
/// </summary>
1417
public IBadges Badges => this;
1518

1619
BaseResponse<Badge> IBadges.GetAllBadges(BadgeFilters filters, string inName)

‎StackExchange.NET/StackExchange.NET/Clients/Comments.cs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ namespace StackExchange.NET.Clients
1111
{
1212
public partial class StackExchangeClient : IComments
1313
{
14+
/// <summary>
15+
/// The Comments interface which lists all possible operations.
16+
/// </summary>
1417
public IComments Comments => this;
1518

1619
BaseResponse<Comment> IComments.GetAllComments(CommentFilter filters)

‎StackExchange.NET/StackExchange.NET/Clients/PostsClient.cs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ namespace StackExchange.NET.Clients
1313
{
1414
public partial class StackExchangeClient : IPosts
1515
{
16+
/// <summary>
17+
/// The Posts interface which lists all possible operations.
18+
/// </summary>
1619
public IPosts Posts => this;
1720

1821
BaseResponse<Post> IPosts.GetAllPosts(PostFilter filters)

‎StackExchange.NET/StackExchange.NET/Exceptions/StackExchangeApiException.cs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
namespace StackExchange.NET.Exceptions
44
{
5+
/// <summary>
6+
/// StackExchangeApiException
7+
/// </summary>
58
public class StackExchangeApiException : Exception
69
{
710
/// <summary>

‎StackExchange.NET/StackExchange.NET/Helpers/ApiUrlBuilder.cs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ public class ApiUrlBuilder : IApiUrlHelper
1111
private string _filter;
1212
private readonly string _apiKey;
1313

14+
/// <summary>
15+
/// Constructor used to Build the api url internally
16+
/// </summary>
17+
/// <param name="apiKey"></param>
1418
public ApiUrlBuilder(string apiKey)
1519
{
1620
_apiKey = apiKey;

‎StackExchange.NET/StackExchange.NET/Helpers/ClientType.cs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
namespace StackExchange.NET.Helpers
22
{
3+
/// <summary>
4+
/// The list of Interfaces exposed for consuming the API
5+
/// </summary>
36
public enum ClientType
47
{
58
Answers,

‎StackExchange.NET/StackExchange.NET/Helpers/ExtensionMethods.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ namespace StackExchange.NET.Helpers
1010
{
1111
internal static class ExtensionMethods
1212
{
13-
public static string GetQueryString(this object obj)
13+
internal static string GetQueryString(this object obj)
1414
{
1515
var properties = from p in obj.GetType().GetProperties()
1616
where p.GetValue(obj, null) != null

‎StackExchange.NET/StackExchange.NET/Helpers/MakeSure.cs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
namespace StackExchange.NET.Helpers
66
{
7+
/// <summary>
8+
/// Used for Validating parameters for Exceptions
9+
/// </summary>
710
public abstract class MakeSure
811
{
912
/// <summary>Checks an argument to make sure it isn't null</summary>

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /