Move comment to <remarks> section

This commit is contained in:
Ryan Gribble
2016-08-15 21:13:53 +10:00
parent 0b1280e8e5
commit c96ee7ac01
4 changed files with 12 additions and 4 deletions
@@ -9,6 +9,9 @@ namespace Octokit
/// <summary>
/// Specifies the requested settings for branch protection
/// </summary>
/// <remarks>
/// Note: this is a PREVIEW api: https://developer.github.com/changes/2016-06-27-protected-branches-api-update/
/// </remarks>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public class BranchProtectionSettingsUpdate
{
+3 -1
View File
@@ -6,8 +6,10 @@ namespace Octokit
{
/// <summary>
/// Specifies the values used to update a <see cref="Branch"/>.
/// Note: this is a PREVIEW api: https://developer.github.com/changes/2015-11-11-protected-branches-api/
/// </summary>
/// <remarks>
/// Note: this is a PREVIEW api: https://developer.github.com/changes/2015-11-11-protected-branches-api/
/// </remarks>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
public class BranchUpdate
-1
View File
@@ -38,7 +38,6 @@ namespace Octokit
/// <summary>
/// The <see cref="BranchProtection"/> details for this <see cref="Branch"/>.
/// Note: this is a PREVIEW api: https://developer.github.com/changes/2015-11-11-protected-branches-api/
/// </summary>
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.", false)]
public BranchProtection Protection { get; protected set; }
+6 -2
View File
@@ -9,8 +9,10 @@ namespace Octokit
{
/// <summary>
/// Protection details for a <see cref="Branch"/>.
/// Note: this is a PREVIEW api: https://developer.github.com/changes/2015-11-11-protected-branches-api/
/// </summary>
/// <remarks>
/// Note: this is a PREVIEW api: https://developer.github.com/changes/2015-11-11-protected-branches-api/
/// </remarks>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
public class BranchProtection
@@ -97,8 +99,10 @@ namespace Octokit
/// <summary>
/// Protection details for a <see cref="Branch"/>.
/// Note: this is a PREVIEW api: https://developer.github.com/changes/2016-06-27-protected-branches-api-update/
/// </summary>
/// <remarks>
/// Note: this is a PREVIEW api: https://developer.github.com/changes/2016-06-27-protected-branches-api-update/
/// </remarks>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public class BranchProtectionSettings
{