zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-06-08 12:42:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update IMilestoneClient docs

Browse Source
This commit is contained in:
Keith Dahlby
2013-10-30 23:04:09 -05:00
parent 9b5b00ba20
commit e6ec2651da
2 changed files with 14 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit/Clients/IMilestonesClient.cs
+7 -8
View File
@@ -7,11 +7,10 @@ namespace Octokit
public interface IMilestonesClient
{
/// <summary>
/// Gets all Milestones across all the authenticated user’s visible repositories including owned repositories,
/// member repositories, and organization repositories.
/// Gets a single Milestone by number.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/Milestones/#get-a-single-Milestone
/// http://developer.github.com/v3/issues/milestones/#get-a-single-milestone
/// </remarks>
/// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
@@ -22,7 +21,7 @@ namespace Octokit
/// Gets all open milestones for the repository.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/Milestones/#list-Milestones-for-a-repository
/// http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
@@ -33,7 +32,7 @@ namespace Octokit
/// Gets all open milestones for the repository.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/Milestones/#list-Milestones-for-a-repository
/// http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
@@ -45,7 +44,7 @@ namespace Octokit
/// Creates a milestone for the specified repository. Any user with pull access to a repository can create an
/// Milestone.
/// </summary>
/// <remarks>http://developer.github.com/v3/Milestones/#create-an-Milestone</remarks>
/// <remarks>http://developer.github.com/v3/issues/milestones/#create-a-milestone</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="newMilestone">A <see cref="NewMilestone"/> instance describing the new Milestone to create</param>
@@ -56,7 +55,7 @@ namespace Octokit
/// Creates a milestone for the specified repository. Any user with pull access to a repository can create an
/// Milestone.
/// </summary>
/// <remarks>http://developer.github.com/v3/Milestones/#update-a-milestone</remarks>
/// <remarks>http://developer.github.com/v3/issues/milestones/#update-a-milestone</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The Milestone number</param>
@@ -69,7 +68,7 @@ namespace Octokit
/// Deletes a milestone for the specified repository. Any user with pull access to a repository can create an
/// Milestone.
/// </summary>
/// <remarks>http://developer.github.com/v3/Milestones/#delete-a-milestone</remarks>
/// <remarks>http://developer.github.com/v3/issues/milestones/#delete-a-milestone</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The milestone number</param>
Octokit/Clients/MilestonesClient.cs
+7 -8
View File
@@ -11,11 +11,10 @@ namespace Octokit
}
/// <summary>
/// Gets all Milestones across all the authenticated user’s visible repositories including owned repositories,
/// member repositories, and organization repositories.
/// Gets a single Milestone by number.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/Milestones/#get-a-single-Milestone
/// http://developer.github.com/v3/issues/milestones/#get-a-single-Milestone
/// </remarks>
/// <returns></returns>
public Task<Milestone> Get(string owner, string name, int number)
@@ -30,7 +29,7 @@ namespace Octokit
/// Gets all open milestones for the repository.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/Milestones/#list-Milestones-for-a-repository
/// http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
@@ -44,7 +43,7 @@ namespace Octokit
/// Gets all open milestones for the repository.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/Milestones/#list-Milestones-for-a-repository
/// http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
@@ -64,7 +63,7 @@ namespace Octokit
/// Creates an Milestone for the specified repository. Any user with pull access to a repository can create an
/// Milestone.
/// </summary>
/// <remarks>http://developer.github.com/v3/Milestones/#create-an-Milestone</remarks>
/// <remarks>http://developer.github.com/v3/issues/milestones/#create-a-milestone</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="newMilestone">A <see cref="NewMilestone"/> instance describing the new Milestone to create</param>
@@ -82,7 +81,7 @@ namespace Octokit
/// Creates an Milestone for the specified repository. Any user with pull access to a repository can create an
/// Milestone.
/// </summary>
/// <remarks>http://developer.github.com/v3/Milestones/#create-an-Milestone</remarks>
/// <remarks>http://developer.github.com/v3/issues/milestones/#create-a-milestone</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The Milestone number</param>
@@ -102,7 +101,7 @@ namespace Octokit
/// Deletes a milestone for the specified repository. Any user with pull access to a repository can create an
/// Milestone.
/// </summary>
/// <remarks>http://developer.github.com/v3/Milestones/#delete-a-milestone</remarks>
/// <remarks>http://developer.github.com/v3/issues/milestones/#delete-a-milestone</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The milestone number</param>