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

updated XML docs

Browse Source
This commit is contained in:
aedampir@gmail.com
2016-06-29 01:43:40 +07:00
parent e617541c2a
commit f8eebd814e
2 changed files with 15 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit.Reactive/Clients/IObservableRepositoryHooksClient.cs
+7 -7
View File
@@ -42,7 +42,7 @@ namespace Octokit.Reactive
/// <summary>
/// Gets the list of hooks defined for a repository
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="repositoryId">The repository's ID</param>
/// <param name="options">Options for changing the API response</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns></returns>
@@ -62,7 +62,7 @@ namespace Octokit.Reactive
/// <summary>
/// Gets a single hook by Id
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="repositoryId">The repository's ID</param>
/// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks>
/// <returns></returns>
@@ -82,7 +82,7 @@ namespace Octokit.Reactive
/// <summary>
/// Creates a hook for a repository
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="repositoryId">The repository's ID</param>
/// <param name="hook">The hook's parameters</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks>
/// <returns></returns>
@@ -102,7 +102,7 @@ namespace Octokit.Reactive
/// <summary>
/// Edits a hook for a repository
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="repositoryId">The repository's ID</param>
/// <param name="hookId">The repository's hook id</param>
/// <param name="hook">The requested changes to an edit repository hook</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks>
@@ -124,7 +124,7 @@ namespace Octokit.Reactive
/// <summary>
/// Tests a hook for a repository
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="repositoryId">The repository's ID</param>
/// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#test-a-hook">API documentation</a> for more information.
/// This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook
@@ -145,7 +145,7 @@ namespace Octokit.Reactive
/// <summary>
/// This will trigger a ping event to be sent to the hook.
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="repositoryId">The repository's ID</param>
/// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks>
/// <returns></returns>
@@ -164,7 +164,7 @@ namespace Octokit.Reactive
/// <summary>
/// Deletes a hook for a repository
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="repositoryId">The repository's ID</param>
/// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#delete-a-hook">API documentation</a> for more information.</remarks>
/// <returns></returns>
Octokit.Reactive/Clients/ObservableRepositoryHooksClient.cs
+8 -12
View File
@@ -15,11 +15,7 @@ namespace Octokit.Reactive
{
readonly IRepositoryHooksClient _client;
readonly IConnection _connection;
/// <summary>
/// Initializes a new GitHub Webhooks API client.
/// </summary>
/// <param name="client"></param>
public ObservableRepositoryHooksClient(IGitHubClient client)
{
Ensure.ArgumentNotNull(client, "client");
@@ -74,7 +70,7 @@ namespace Octokit.Reactive
/// <summary>
/// Gets the list of hooks defined for a repository
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="repositoryId">The repository's ID</param>
/// <param name="options">Options for changing the API response</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns></returns>
@@ -104,7 +100,7 @@ namespace Octokit.Reactive
/// <summary>
/// Gets a single hook by Id
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="repositoryId">The repository's ID</param>
/// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks>
/// <returns></returns>
@@ -133,7 +129,7 @@ namespace Octokit.Reactive
/// <summary>
/// Creates a hook for a repository
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="repositoryId">The repository's ID</param>
/// <param name="hook">The hook's parameters</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks>
/// <returns></returns>
@@ -165,7 +161,7 @@ namespace Octokit.Reactive
/// <summary>
/// Edits a hook for a repository
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="repositoryId">The repository's ID</param>
/// <param name="hookId">The repository's hook id</param>
/// <param name="hook">The requested changes to an edit repository hook</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks>
@@ -198,7 +194,7 @@ namespace Octokit.Reactive
/// <summary>
/// Tests a hook for a repository
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="repositoryId">The repository's ID</param>
/// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#test-a-hook">API documentation</a> for more information.
/// This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook
@@ -228,7 +224,7 @@ namespace Octokit.Reactive
/// <summary>
/// This will trigger a ping event to be sent to the hook.
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="repositoryId">The repository's ID</param>
/// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks>
/// <returns></returns>
@@ -256,7 +252,7 @@ namespace Octokit.Reactive
/// <summary>
/// Deletes a hook for a repository
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="repositoryId">The repository's ID</param>
/// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#delete-a-hook">API documentation</a> for more information.</remarks>
/// <returns></returns>