mirror of
https://github.com/zoriya/octokit.net.git
synced 2026-06-02 02:45:32 +00:00
Add missing xml comments
This commit is contained in:
@@ -12,6 +12,16 @@ namespace Octokit
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets all events for the issue.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// http://developer.github.com/v3/issues/events/#list-events-for-an-issue
|
||||
/// </remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <param name="number">The issue number</param>
|
||||
/// <returns></returns>
|
||||
public Task<IReadOnlyList<EventInfo>> GetForIssue(string owner, string name, int number)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -20,6 +30,15 @@ namespace Octokit
|
||||
return ApiConnection.GetAll<EventInfo>(ApiUrls.IssuesEvents(owner, name, number));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets all events for the repository.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// http://developer.github.com/v3/issues/events/#list-events-for-a-repository
|
||||
/// </remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <returns></returns>
|
||||
public Task<IReadOnlyList<IssueEvent>> GetForRepository(string owner, string name)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -28,6 +47,16 @@ namespace Octokit
|
||||
return ApiConnection.GetAll<IssueEvent>(ApiUrls.IssuesEvents(owner, name));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a single event
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// http://developer.github.com/v3/issues/events/#get-a-single-event
|
||||
/// </remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <param name="number">The event id</param>
|
||||
/// <returns></returns>
|
||||
public Task<IssueEvent> Get(string owner, string name, int number)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
|
||||
@@ -9,20 +9,23 @@ namespace Octokit
|
||||
/// </summary>
|
||||
public int Id { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The URL for this event.
|
||||
/// </summary>
|
||||
public Uri Url { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Always the User that generated the event
|
||||
/// Always the User that generated the event.
|
||||
/// </summary>
|
||||
public Actor Actor { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Identifies the actual type of Event that occurred
|
||||
/// Identifies the actual type of Event that occurred.
|
||||
/// </summary>
|
||||
public EventInfoState InfoState { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The String SHA of a commit that referenced this Issue
|
||||
/// The String SHA of a commit that referenced this Issue.
|
||||
/// </summary>
|
||||
public string CommitId { get; set; }
|
||||
|
||||
|
||||
@@ -9,20 +9,23 @@ namespace Octokit
|
||||
/// </summary>
|
||||
public int Id { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The URL for this issue/pull request event.
|
||||
/// </summary>
|
||||
public Uri Url { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Always the User that generated the event
|
||||
/// Always the User that generated the event.
|
||||
/// </summary>
|
||||
public Actor Actor { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Identifies the actual type of Event that occurred
|
||||
/// Identifies the actual type of Event that occurred.
|
||||
/// </summary>
|
||||
public EventInfoState InfoState { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The String SHA of a commit that referenced this Issue
|
||||
/// The String SHA of a commit that referenced this Issue.
|
||||
/// </summary>
|
||||
public string CommitId { get; set; }
|
||||
|
||||
@@ -31,6 +34,9 @@ namespace Octokit
|
||||
/// </summary>
|
||||
public DateTimeOffset CreatedAt { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The issue associated to this event.
|
||||
/// </summary>
|
||||
public Issue Issue { get; set; }
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user