Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix XmlDoc parameter warnings (and tidy up other build output/warnings) #1779

Merged
merged 5 commits into from
Mar 6, 2018
Merged

Fix XmlDoc parameter warnings (and tidy up other build output/warnings) #1779

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d4d2fe8
ignore "missing XmlComment for publicly visible member" warning
ryangribble Feb 22, 2018
1e59c2f
fixup incorrect xml param comments
ryangribble Feb 22, 2018
2685910
remove linked file as there is a project reference in place anyway
ryangribble Feb 22, 2018
41216a6
remove unused variable
ryangribble Feb 22, 2018
7263962
tidy up convention tests that are being skipped due to duplicate enum…
ryangribble Mar 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Octokit.Reactive/Clients/IObservableProjectsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public interface IObservableProjectsClient
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="name">The name of the repository</param>
IObservable<Project> GetAllForRepository(string owner, string name);

/// <summary>
Expand All @@ -28,7 +28,7 @@ public interface IObservableProjectsClient
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter the list of projects returned</param>
IObservable<Project> GetAllForRepository(string owner, string name, ProjectRequest request);

Expand Down Expand Up @@ -58,7 +58,7 @@ public interface IObservableProjectsClient
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="options">Options for changing the API response</param>
IObservable<Project> GetAllForRepository(string owner, string name, ApiOptions options);

Expand All @@ -69,7 +69,7 @@ public interface IObservableProjectsClient
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter the list of projects returned</param>
/// <param name="options">Options for changing the API response</param>
IObservable<Project> GetAllForRepository(string owner, string name, ProjectRequest request, ApiOptions options);
Expand Down
2 changes: 2 additions & 0 deletions Octokit.Reactive/Clients/IObservablePullRequestReviewsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ public interface IObservablePullRequestReviewsClient
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="reviewId">The pull request review number</param>
/// <param name="options">Options for changing the API response</param>
IObservable<PullRequestReviewComment> GetAllComments(string owner, string name, int number, long reviewId, ApiOptions options);

/// <summary>
Expand All @@ -182,6 +183,7 @@ public interface IObservablePullRequestReviewsClient
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="reviewId">The pull request review number</param>
/// <param name="options">Options for changing the API response</param>
IObservable<PullRequestReviewComment> GetAllComments(long repositoryId, int number, long reviewId, ApiOptions options);
}
}
2 changes: 2 additions & 0 deletions Octokit.Reactive/Clients/IObservableRepositoryBranchesClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,6 +348,7 @@ public interface IObservableRepositoryBranchesClient
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="branch">The name of the branch</param>
/// <param name="update">The required pull request review settings</param>
IObservable<BranchProtectionRequiredReviews> UpdateReviewEnforcement(string owner, string name, string branch, BranchProtectionRequiredReviewsUpdate update);

/// <summary>
Expand All @@ -358,6 +359,7 @@ public interface IObservableRepositoryBranchesClient
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="branch">The name of the branch</param>
/// <param name="update">The required pull request review settings</param>
IObservable<BranchProtectionRequiredReviews> UpdateReviewEnforcement(long repositoryId, string branch, BranchProtectionRequiredReviewsUpdate update);

/// <summary>
Expand Down
5 changes: 3 additions & 2 deletions Octokit.Reactive/Clients/IObservableTeamsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,19 +61,20 @@ public interface IObservableTeamsClient
/// <summary>
/// Returns all child teams of the given team.
/// </summary>
/// <param name="id">The team identifier</param>
/// <remarks>
/// https://developer.github.com/v3/orgs/teams/#list-child-teams
/// </remarks>
/// <param name="id">The team identifier</param>
IObservable<Team> GetAllChildTeams(int id);

/// <summary>
/// Returns all child teams of the given team.
/// </summary>
/// <param name="id">The team identifier</param>
/// <remarks>
/// https://developer.github.com/v3/orgs/teams/#list-child-teams
/// </remarks>
/// <param name="id">The team identifier</param>
/// <param name="options">Options for changing the API response</param>
IObservable<Team> GetAllChildTeams(int id, ApiOptions options);

/// <summary>
Expand Down
12 changes: 6 additions & 6 deletions Octokit.Reactive/Clients/ObservableProjectsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public ObservableProjectsClient(IGitHubClient client)
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="name">The name of the repository</param>
public IObservable<Project> GetAllForRepository(string owner, string name)
{
return GetAllForRepository(owner, name, ApiOptions.None);
Expand All @@ -47,7 +47,8 @@ public IObservable<Project> GetAllForRepository(string owner, string name)
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="options">Options for changing the API response</param>
public IObservable<Project> GetAllForRepository(string owner, string name, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Expand All @@ -66,7 +67,7 @@ public IObservable<Project> GetAllForRepository(string owner, string name, ApiOp
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter the list of projects returned</param>
public IObservable<Project> GetAllForRepository(string owner, string name, ProjectRequest request)
{
Expand All @@ -80,7 +81,7 @@ public IObservable<Project> GetAllForRepository(string owner, string name, Proje
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter the list of projects returned</param>
/// <param name="options">Options for changing the API response</param>
public IObservable<Project> GetAllForRepository(string owner, string name, ProjectRequest request, ApiOptions options)
Expand Down Expand Up @@ -113,8 +114,7 @@ public IObservable<Project> GetAllForRepository(long repositoryId)
/// <remarks>
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="options">Options for changing the API response</param>
public IObservable<Project> GetAllForRepository(long repositoryId, ApiOptions options)
{
Expand Down
2 changes: 2 additions & 0 deletions Octokit.Reactive/Clients/ObservablePullRequestReviewsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,7 @@ public IObservable<PullRequestReviewComment> GetAllComments(long repositoryId, i
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="reviewId">The pull request review number</param>
/// <param name="options">Options for changing the API response</param>
public IObservable<PullRequestReviewComment> GetAllComments(string owner, string name, int number, long reviewId, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Expand All @@ -282,6 +283,7 @@ public IObservable<PullRequestReviewComment> GetAllComments(string owner, string
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="reviewId">The pull request review number</param>
/// <param name="options">Options for changing the API response</param>
public IObservable<PullRequestReviewComment> GetAllComments(long repositoryId, int number, long reviewId, ApiOptions options)
{
Ensure.ArgumentNotNull(options, nameof(options));
Expand Down
2 changes: 2 additions & 0 deletions Octokit.Reactive/Clients/ObservableRepositoryBranchesClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -537,6 +537,7 @@ public IObservable<BranchProtectionRequiredReviews> GetReviewEnforcement(long re
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="branch">The name of the branch</param>
/// <param name="update">The required pull request review settings</param>
public IObservable<BranchProtectionRequiredReviews> UpdateReviewEnforcement(string owner, string name, string branch, BranchProtectionRequiredReviewsUpdate update)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Expand All @@ -555,6 +556,7 @@ public IObservable<BranchProtectionRequiredReviews> UpdateReviewEnforcement(stri
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="branch">The name of the branch</param>
/// <param name="update">The required pull request review settings</param>
public IObservable<BranchProtectionRequiredReviews> UpdateReviewEnforcement(long repositoryId, string branch, BranchProtectionRequiredReviewsUpdate update)
{
Ensure.ArgumentNotNullOrEmptyString(branch, "branch");
Expand Down
3 changes: 2 additions & 1 deletion Octokit.Reactive/Clients/ObservableTeamsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,11 @@ public IObservable<Team> GetAllChildTeams(int id)
/// <summary>
/// Returns all child teams of the given team.
/// </summary>
/// <param name="id">The team identifier</param>
/// <remarks>
/// https://developer.github.com/v3/orgs/teams/#list-child-teams
/// </remarks>
/// <param name="id">The team identifier</param>
/// <param name="options">Options to change API behaviour.</param>
public IObservable<Team> GetAllChildTeams(int id, ApiOptions options)
{
Ensure.ArgumentNotNull(options, "options");
Expand Down
4 changes: 4 additions & 0 deletions Octokit.Reactive/Octokit.Reactive.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@
<Copyright>Copyright GitHub 2017</Copyright>
</PropertyGroup>

<PropertyGroup>
<NoWarn>1591;1701;1702;1705</NoWarn>
</PropertyGroup>

<ItemGroup>
<Compile Include="..\Octokit\Helpers\Ensure.cs;..\Octokit\Helpers\Pagination.cs" />
<None Include="app.config" />
Expand Down
1 change: 1 addition & 0 deletions Octokit.Tests.Conventions/ModelTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,7 @@ public static IEnumerable<object[]> EnumTypes
.SelectMany(type => type.GetProperties())
.SelectMany(property => UnwrapGenericArguments(property.PropertyType))
.Where(type => type.GetTypeInfo().Assembly.Equals(Octokit) && type.GetTypeInfo().IsEnum)
.Distinct()
.Select(type => new[] { type });
}
}
Expand Down
1 change: 0 additions & 1 deletion Octokit.Tests.Conventions/Octokit.Tests.Conventions.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
</PropertyGroup>

<ItemGroup>
<Compile Include="..\Octokit.Tests\Helpers\AssertEx.cs" />
<None Include="app.config" />
<Content Include="xunit.runner.json">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
Expand Down
1 change: 0 additions & 1 deletion Octokit.Tests.Integration/Clients/AssigneesClientTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ public class AssigneesClientTests
{
readonly IGitHubClient _github;
readonly RepositoryContext _context;
readonly IIssuesClient _issuesClient;

public AssigneesClientTests()
{
Expand Down
8 changes: 4 additions & 4 deletions Octokit/Clients/IProjectsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public interface IProjectsClient
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="name">The name of the repository</param>
Task<IReadOnlyList<Project>> GetAllForRepository(string owner, string name);

/// <summary>
Expand All @@ -29,7 +29,7 @@ public interface IProjectsClient
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter the list of projects returned</param>
Task<IReadOnlyList<Project>> GetAllForRepository(string owner, string name, ProjectRequest request);

Expand Down Expand Up @@ -59,7 +59,7 @@ public interface IProjectsClient
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="options">Options for changing the API response</param>
Task<IReadOnlyList<Project>> GetAllForRepository(string owner, string name, ApiOptions options);

Expand All @@ -70,7 +70,7 @@ public interface IProjectsClient
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter the list of projects returned</param>
/// <param name="options">Options for changing the API response</param>
Task<IReadOnlyList<Project>> GetAllForRepository(string owner, string name, ProjectRequest request, ApiOptions options);
Expand Down
2 changes: 2 additions & 0 deletions Octokit/Clients/IRepositoryBranchesClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,7 @@ public interface IRepositoryBranchesClient
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="branch">The name of the branch</param>
/// <param name="update">The required pull request review settings</param>
Task<BranchProtectionRequiredReviews> UpdateReviewEnforcement(string owner, string name, string branch, BranchProtectionRequiredReviewsUpdate update);

/// <summary>
Expand All @@ -362,6 +363,7 @@ public interface IRepositoryBranchesClient
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="branch">The name of the branch</param>
/// <param name="update">The required pull request review settings</param>
Task<BranchProtectionRequiredReviews> UpdateReviewEnforcement(long repositoryId, string branch, BranchProtectionRequiredReviewsUpdate update);

/// <summary>
Expand Down
5 changes: 3 additions & 2 deletions Octokit/Clients/ITeamsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,19 +62,20 @@ public interface ITeamsClient
/// <summary>
/// Returns all child teams of the given team.
/// </summary>
/// <param name="id">The team identifier</param>
/// <remarks>
/// https://developer.github.com/v3/orgs/teams/#list-child-teams
/// </remarks>
/// <param name="id">The team identifier</param>
Task<IReadOnlyList<Team>> GetAllChildTeams(int id);

/// <summary>
/// Returns all child teams of the given team.
/// </summary>
/// <param name="id">The team identifier</param>
/// <remarks>
/// https://developer.github.com/v3/orgs/teams/#list-child-teams
/// </remarks>
/// <param name="id">The team identifier</param>
/// <param name="options">Options to change API behaviour.</param>
Task<IReadOnlyList<Team>> GetAllChildTeams(int id, ApiOptions options);

/// <summary>
Expand Down
Loading