From 31ed5111dd653190756facfdfe59b9a03126aa14 Mon Sep 17 00:00:00 2001 From: Henrik Andersson Date: Sun, 2 Feb 2014 12:02:10 +1000 Subject: [PATCH] Add doc comments to API URL functions --- Octokit/Helpers/ApiUrls.cs | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/Octokit/Helpers/ApiUrls.cs b/Octokit/Helpers/ApiUrls.cs index de29e397..be4379eb 100644 --- a/Octokit/Helpers/ApiUrls.cs +++ b/Octokit/Helpers/ApiUrls.cs @@ -834,31 +834,63 @@ namespace Octokit return "search/code".FormatUri(); } + /// + /// Creates the relative for retrieving the + /// current users followers + /// + /// The for retrieving the current users followers public static Uri Followers() { return "user/followers".FormatUri(); } + /// + /// Creates the relative for retrieving + /// the followers for the specified user + /// + /// name of the user + /// The for retrieving the specified users followers public static Uri Followers(string login) { return "users/{0}/followers".FormatUri(login); } + /// + /// Creates the relative for retrieving the users the current user follows + /// + /// The for retrieiving the users the current user follows public static Uri Following() { return "user/following".FormatUri(); } + /// + /// Creates the relative for retrieving the users the specified user follows + /// + /// name of the user + /// The for retrieving the users the specified user follows public static Uri Following(string login) { return "users/{0}/following".FormatUri(login); } + /// + /// Creates the relative for checking is the current user is following + /// another user + /// + /// name of the user followed + /// The for checking if the current user follows the specified user. public static Uri IsFollowing(string following) { return "user/following/{0}".FormatUri(following); } + /// + /// Creates the relative for checking if a user is following another user + /// + /// name of the user following + /// name of the user followed + /// The for checking if the specified user follows another user public static Uri IsFollowing(string login, string following) { return "users/{0}/following/{1}".FormatUri(login, following);