mirror of
https://github.com/zoriya/octokit.net.git
synced 2026-06-08 12:42:32 +00:00
API interface summaries
Modified existing comments in IGitDatabaseClient, IMiscellaneousClient and ITeamsClient. Hopefully for valid reasons.
This commit is contained in:
@@ -1,5 +1,11 @@
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Activity API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/activity/">Activity API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface IActivitiesClient
|
||||
{
|
||||
IEventsClient Events { get; }
|
||||
|
||||
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Issue Assignees API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/issues/assignees/">Issue Assignees API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface IAssigneesClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -2,6 +2,12 @@
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Git Blobs API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/git/blobs/">Git Blobs API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface IBlobsClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Git Repository Status API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/repos/statuses/">Repository Statuses API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface ICommitStatusClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Git Commits API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/git/commits/">Git Commits API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface ICommitsClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Activity Events API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/activity/events/">Activity Events API documentation</a> for more information
|
||||
/// </remarks>
|
||||
public interface IEventsClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Gist Comments API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/gists/comments/">Gist Comments API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface IGistCommentsClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Gists API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/gists/">Gists API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface IGistsClient
|
||||
{
|
||||
IGistCommentsClient Comment { get; set; }
|
||||
|
||||
@@ -1,8 +1,11 @@
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// Used to maintain api structure therefore contains no methods
|
||||
/// A client for GitHub's Git API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/git/">Git API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface IGitDatabaseClient
|
||||
{
|
||||
IBlobsClient Blob { get; set; }
|
||||
|
||||
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Issue Comments API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/issues/comments/">Issue Comments API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface IIssueCommentsClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Issues API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/issues/">Issues API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface IIssuesClient
|
||||
{
|
||||
IAssigneesClient Assignee { get; }
|
||||
|
||||
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Issue Events API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/issues/events/">Issue Events API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface IIssuesEventsClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Issue Milestones API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/issues/milestones/">Issue Milestones API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface IMilestonesClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -11,7 +11,7 @@ namespace Octokit
|
||||
/// A client for GitHub's miscellaneous APIs.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/misc/">miscellaneous API documentation</a> for more details.
|
||||
/// See the <a href="http://developer.github.com/v3/misc/">Miscellaneous API documentation</a> for more details.
|
||||
/// </remarks>
|
||||
public interface IMiscellaneousClient
|
||||
{
|
||||
|
||||
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Activity Notifications API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/activity/notifications/">Activity Notifications API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface INotificationsClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Organization Members API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/orgs/members/">Orgs API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface IOrganizationMembersClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's References API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/git/refs/">References API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface IReferencesClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's User Keys API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/users/keys/">Users API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface ISshKeysClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Activity Starring API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/activity/starring/">Activity Starring API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface IStarredClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Git Tags API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/git/tags/">Git Tags API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface ITagsClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -7,10 +7,10 @@ using System.Threading.Tasks;
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Org Teams API.
|
||||
/// A client for GitHub's Organization Teams API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/orgs/teams/">Orgs API documentation</a> for more information.
|
||||
/// See the <a href="http://developer.github.com/v3/orgs/teams/">Organization Teams API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface ITeamsClient
|
||||
{
|
||||
|
||||
@@ -2,6 +2,12 @@
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Git Trees API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/git/trees/">Git Trees API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface ITreesClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Users API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/users/">Users API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface IUsersClient
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
Reference in New Issue
Block a user