mirror of
https://github.com/zoriya/octokit.net.git
synced 2026-06-01 10:25:36 +00:00
better documentation
This commit is contained in:
@@ -12,30 +12,34 @@ namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// search repos
|
||||
/// http://developer.github.com/v3/search/#search-repositories
|
||||
/// </summary>
|
||||
/// <param name="search"></param>
|
||||
/// <returns></returns>
|
||||
/// <returns>List of repos</returns>
|
||||
Task<IReadOnlyList<SearchRepo>> SearchRepo(SearchTerm search);
|
||||
|
||||
/// <summary>
|
||||
/// search users
|
||||
/// http://developer.github.com/v3/search/#search-users
|
||||
/// </summary>
|
||||
/// <param name="search"></param>
|
||||
/// <returns></returns>
|
||||
/// <returns>List of users</returns>
|
||||
Task<IReadOnlyList<SearchUser>> SearchUsers(SearchTerm search);
|
||||
|
||||
/// <summary>
|
||||
/// search issues
|
||||
/// http://developer.github.com/v3/search/#search-issues
|
||||
/// </summary>
|
||||
/// <param name="search"></param>
|
||||
/// <returns></returns>
|
||||
/// <returns>List of issues</returns>
|
||||
Task<IReadOnlyList<SearchIssue>> SearchIssues(SearchTerm search);
|
||||
|
||||
/// <summary>
|
||||
/// search code
|
||||
/// http://developer.github.com/v3/search/#search-code
|
||||
/// </summary>
|
||||
/// <param name="search"></param>
|
||||
/// <returns></returns>
|
||||
/// <returns>List of files</returns>
|
||||
Task<IReadOnlyList<SearchCode>> SearchCode(SearchTerm search);
|
||||
}
|
||||
}
|
||||
@@ -16,26 +16,48 @@ namespace Octokit
|
||||
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// search repos
|
||||
/// http://developer.github.com/v3/search/#search-repositories
|
||||
/// </summary>
|
||||
/// <param name="search"></param>
|
||||
/// <returns>List of repos</returns>
|
||||
public Task<IReadOnlyList<SearchRepo>> SearchRepo(SearchTerm search)
|
||||
{
|
||||
Ensure.ArgumentNotNull(search, "search");
|
||||
return ApiConnection.GetAll<SearchRepo>("search/repositories".FormatUri(), search.Parameters);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// search users
|
||||
/// http://developer.github.com/v3/search/#search-users
|
||||
/// </summary>
|
||||
/// <param name="search"></param>
|
||||
/// <returns>List of users</returns>
|
||||
public Task<IReadOnlyList<SearchUser>> SearchUsers(SearchTerm search)
|
||||
{
|
||||
Ensure.ArgumentNotNull(search, "search");
|
||||
return ApiConnection.GetAll<SearchUser>("search/users".FormatUri(), search.Parameters);
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// search issues
|
||||
/// http://developer.github.com/v3/search/#search-issues
|
||||
/// </summary>
|
||||
/// <param name="search"></param>
|
||||
/// <returns>List of issues</returns>
|
||||
public Task<IReadOnlyList<SearchIssue>> SearchIssues(SearchTerm search)
|
||||
{
|
||||
Ensure.ArgumentNotNull(search, "search");
|
||||
return ApiConnection.GetAll<SearchIssue>("search/issues".FormatUri(), search.Parameters);
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// search code
|
||||
/// http://developer.github.com/v3/search/#search-code
|
||||
/// </summary>
|
||||
/// <param name="search"></param>
|
||||
/// <returns>List of files</returns>
|
||||
public Task<IReadOnlyList<SearchCode>> SearchCode(SearchTerm search)
|
||||
{
|
||||
Ensure.ArgumentNotNull(search, "search");
|
||||
|
||||
Reference in New Issue
Block a user