diff --git a/.gitignore b/.gitignore index d053335d..64fac869 100644 --- a/.gitignore +++ b/.gitignore @@ -82,4 +82,7 @@ tools/xunit.runner.console # New VS Test Runner creates arbitrary folders with PDBs *.pdb -pingme.txt \ No newline at end of file +pingme.txt + +# it's 2015, no need to keep this around when migrating projects +Backup/ \ No newline at end of file diff --git a/Octokit.Reactive/Octokit.Reactive.csproj b/Octokit.Reactive/Octokit.Reactive.csproj index 89a6dc7c..40aedf4a 100644 --- a/Octokit.Reactive/Octokit.Reactive.csproj +++ b/Octokit.Reactive/Octokit.Reactive.csproj @@ -39,6 +39,7 @@ true ..\Octokit.ruleset bin\Release\Net45\Octokit.Reactive.XML + 1591 diff --git a/Octokit/Clients/IRepositoryContentsClient.cs b/Octokit/Clients/IRepositoryContentsClient.cs index 45ae800b..2fce3365 100644 --- a/Octokit/Clients/IRepositoryContentsClient.cs +++ b/Octokit/Clients/IRepositoryContentsClient.cs @@ -179,11 +179,21 @@ namespace Octokit Task DeleteFile(string owner, string name, string path, DeleteFileRequest request); } + /// + /// The archive format to return from the server + /// public enum ArchiveFormat { + /// + /// The TAR archive format + /// [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Tarball")] [Parameter(Value = "tarball")] Tarball, + + /// + /// The ZIP archive format + /// [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Zipball")] [Parameter(Value = "zipball")] Zipball diff --git a/Octokit/Clients/OAuthClient.cs b/Octokit/Clients/OAuthClient.cs index 76499cc3..d283b5a4 100644 --- a/Octokit/Clients/OAuthClient.cs +++ b/Octokit/Clients/OAuthClient.cs @@ -12,6 +12,10 @@ namespace Octokit readonly IConnection connection; readonly Uri hostAddress; + /// + /// Create an instance of the OauthClient + /// + /// The underlying connection to use public OauthClient(IConnection connection) { Ensure.ArgumentNotNull(connection, "connection"); diff --git a/Octokit/Clients/RepositoryContentsClient.cs b/Octokit/Clients/RepositoryContentsClient.cs index 3e350e3f..f2a2e4c8 100644 --- a/Octokit/Clients/RepositoryContentsClient.cs +++ b/Octokit/Clients/RepositoryContentsClient.cs @@ -9,6 +9,10 @@ namespace Octokit /// public class RepositoryContentsClient : ApiClient, IRepositoryContentsClient { + /// + /// Create an instance of the RepositoryContentsClient + /// + /// The underlying connection to use public RepositoryContentsClient(IApiConnection apiConnection) : base(apiConnection) { } diff --git a/Octokit/Http/ApiResponse.cs b/Octokit/Http/ApiResponse.cs index 8b1c117c..d677af0c 100644 --- a/Octokit/Http/ApiResponse.cs +++ b/Octokit/Http/ApiResponse.cs @@ -1,11 +1,24 @@ namespace Octokit.Internal { + /// + /// Wrapper for a response from the API + /// + /// Payload contained in the response public class ApiResponse : IApiResponse { + /// + /// Create a ApiResponse from an existing request + /// + /// An existing request to wrap public ApiResponse(IResponse response) : this(response, GetBodyAsObject(response)) { } + /// + /// Create a ApiResponse from an existing request and object + /// + /// An existing request to wrap + /// The payload from an existing request public ApiResponse(IResponse response, T bodyAsObject) { Ensure.ArgumentNotNull(response, "response"); @@ -14,8 +27,14 @@ Body = bodyAsObject; } + /// + /// The payload of the response + /// public T Body { get; private set; } + /// + /// The context of the response + /// public IResponse HttpResponse { get; private set; } static T GetBodyAsObject(IResponse response) diff --git a/Octokit/Http/HttpVerb.cs b/Octokit/Http/HttpVerb.cs index 8454e65a..ad49fb78 100644 --- a/Octokit/Http/HttpVerb.cs +++ b/Octokit/Http/HttpVerb.cs @@ -2,11 +2,11 @@ namespace Octokit.Internal { - public static class HttpVerb + internal static class HttpVerb { static readonly HttpMethod patch = new HttpMethod("PATCH"); - public static HttpMethod Patch + internal static HttpMethod Patch { get { return patch; } } diff --git a/Octokit/Http/ICredentialStore.cs b/Octokit/Http/ICredentialStore.cs index d605678a..19e99b50 100644 --- a/Octokit/Http/ICredentialStore.cs +++ b/Octokit/Http/ICredentialStore.cs @@ -3,8 +3,15 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// Abstraction for interacting with credentials + /// public interface ICredentialStore { + /// + /// Retrieve the credentials from the underlying store + /// + /// A continuation containing credentials [SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate", Justification="Nope")] Task GetCredentials(); } diff --git a/Octokit/Http/InMemoryCredentialStore.cs b/Octokit/Http/InMemoryCredentialStore.cs index 33bce5d0..04ceec9e 100644 --- a/Octokit/Http/InMemoryCredentialStore.cs +++ b/Octokit/Http/InMemoryCredentialStore.cs @@ -2,10 +2,17 @@ namespace Octokit.Internal { + /// + /// Abstraction for interacting with credentials + /// public class InMemoryCredentialStore : ICredentialStore { readonly Credentials _credentials; + /// + /// Create an instance of the InMemoryCredentialStore + /// + /// public InMemoryCredentialStore(Credentials credentials) { Ensure.ArgumentNotNull(credentials, "credentials"); @@ -13,6 +20,10 @@ namespace Octokit.Internal _credentials = credentials; } + /// + /// Retrieve the credentials from the underlying store + /// + /// A continuation containing credentials public Task GetCredentials() { return Task.FromResult(_credentials); diff --git a/Octokit/Models/Request/NewArbitraryMarkDown.cs b/Octokit/Models/Request/NewArbitraryMarkDown.cs index a2993f9c..75e18f56 100644 --- a/Octokit/Models/Request/NewArbitraryMarkDown.cs +++ b/Octokit/Models/Request/NewArbitraryMarkDown.cs @@ -49,7 +49,6 @@ namespace Octokit /// /// The Markdown text to render /// The rendering mode. Can be either markdown by default or gfm - /// public NewArbitraryMarkdown(string text, string mode) : this(text, mode, null) { diff --git a/Octokit/Models/Request/SearchRepositoriesRequest.cs b/Octokit/Models/Request/SearchRepositoriesRequest.cs index 1aa5293e..36da4580 100644 --- a/Octokit/Models/Request/SearchRepositoriesRequest.cs +++ b/Octokit/Models/Request/SearchRepositoriesRequest.cs @@ -310,8 +310,6 @@ namespace Octokit /// /// Matches repositories with regards to both the and dates. /// - /// earlier date of the two - /// latter date of the two public DateRange(DateTime from, DateTime to) { query = string.Format(CultureInfo.InvariantCulture, "{0:yyyy-MM-dd}..{1:yyyy-MM-dd}", from, to); diff --git a/Octokit/Models/Response/Meta.cs b/Octokit/Models/Response/Meta.cs index 66720825..7c829bfa 100644 --- a/Octokit/Models/Response/Meta.cs +++ b/Octokit/Models/Response/Meta.cs @@ -11,10 +11,21 @@ namespace Octokit [DebuggerDisplay("{DebuggerDisplay,nq}")] public class Meta { + /// + /// Create an instance of the Meta + /// public Meta() { } + /// + /// Create an instance of the Meta + /// + /// Whether authentication with username and password is supported. + /// The currently-deployed SHA of github-services. + /// An array of IP addresses in CIDR format specifying the addresses that incoming service hooks will originate from on GitHub.com. + /// An array of IP addresses in CIDR format specifying the Git servers for the GitHub server + /// An array of IP addresses in CIDR format specifying the A records for GitHub Pages. public Meta( bool verifiablePasswordAuthentication, string gitHubServicesSha, diff --git a/Octokit/Octokit-Mono.csproj b/Octokit/Octokit-Mono.csproj index faa20a86..535992f9 100644 --- a/Octokit/Octokit-Mono.csproj +++ b/Octokit/Octokit-Mono.csproj @@ -33,6 +33,7 @@ 4 false bin\Release\Mono\Octokit.XML + 1591 diff --git a/Octokit/Octokit-Portable.csproj b/Octokit/Octokit-Portable.csproj index 6edec2f8..da5eba16 100644 --- a/Octokit/Octokit-Portable.csproj +++ b/Octokit/Octokit-Portable.csproj @@ -38,6 +38,7 @@ false ..\Octokit.ruleset bin\Release\Portable\Octokit.XML + 1591 diff --git a/Octokit/Octokit-netcore45.csproj b/Octokit/Octokit-netcore45.csproj index 6f4de0dd..caef0922 100644 --- a/Octokit/Octokit-netcore45.csproj +++ b/Octokit/Octokit-netcore45.csproj @@ -11,12 +11,15 @@ Properties Octokit Octokit - v4.5 + + 512 en-US {BC8A1FFA-BEE3-4634-8014-F334798102B3};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} en-US 5 + 8.1 + 12 true @@ -42,6 +45,7 @@ true ..\Octokit.ruleset bin\Release\NetCore45\Octokit.XML + 1591 @@ -412,7 +416,7 @@ CustomDictionary.xml - +