Skip to content

Update type/method summaries in FeatureGateAttribute. #170

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

Merged
merged 2 commits into from
Apr 6, 2022
Merged

Update type/method summaries in FeatureGateAttribute. #170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db37f79
Update type/method summaries in FeatureGateAttribute.
jimmyca15 Apr 6, 2022
e23b6db
Add back text.
jimmyca15 Apr 6, 2022
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
10 changes: 5 additions & 5 deletions src/Microsoft.FeatureManagement.AspNetCore/FeatureGateAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@
namespace Microsoft.FeatureManagement.Mvc
{
/// <summary>
/// An attribute that can be placed on MVC actions to require all or any of a set of features to be enabled. If none of the feature are enabled the registered <see cref="IDisabledFeaturesHandler"/> will be invoked.
/// An attribute that can be placed on MVC controllers, controller actions, or Razor pages to require all or any of a set of features to be enabled.
/// </summary>
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = true)]
public class FeatureGateAttribute : ActionFilterAttribute, IAsyncPageFilter
{
/// <summary>
/// Creates an attribute that will gate actions unless all the provided feature(s) are enabled.
/// Creates an attribute that will gate actions or pages unless all the provided feature(s) are enabled.
/// </summary>
/// <param name="features">The names of the features that the attribute will represent.</param>
public FeatureGateAttribute(params string[] features)
Expand All @@ -27,7 +27,7 @@ public FeatureGateAttribute(params string[] features)
}

/// <summary>
/// Creates an attribute that can be used to gate actions. The gate can be configured to require all or any of the provided feature(s) to pass.
/// Creates an attribute that can be used to gate actions or pages. The gate can be configured to require all or any of the provided feature(s) to pass.
/// </summary>
/// <param name="requirementType">Specifies whether all or any of the provided features should be enabled in order to pass.</param>
/// <param name="features">The names of the features that the attribute will represent.</param>
Expand All @@ -44,7 +44,7 @@ public FeatureGateAttribute(RequirementType requirementType, params string[] fea
}

/// <summary>
/// Creates an attribute that will gate actions unless all the provided feature(s) are enabled.
/// Creates an attribute that will gate actions or pages unless all the provided feature(s) are enabled.
/// </summary>
/// <param name="features">A set of enums representing the features that the attribute will represent.</param>
public FeatureGateAttribute(params object[] features)
Expand All @@ -53,7 +53,7 @@ public FeatureGateAttribute(params object[] features)
}

/// <summary>
/// Creates an attribute that can be used to gate actions. The gate can be configured to require all or any of the provided feature(s) to pass.
/// Creates an attribute that can be used to gate actions or pages. The gate can be configured to require all or any of the provided feature(s) to pass.
/// </summary>
/// <param name="requirementType">Specifies whether all or any of the provided features should be enabled in order to pass.</param>
/// <param name="features">A set of enums representing the features that the attribute will represent.</param>
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.FeatureManagement.AspNetCore/Microsoft.FeatureManagement.AspNetCore.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<PropertyGroup>
<MajorVersion>2</MajorVersion>
<MinorVersion>5</MinorVersion>
<PatchVersion>0</PatchVersion>
<PatchVersion>1</PatchVersion>
</PropertyGroup>

<Import Project="..\..\build\Versioning.props" />
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.FeatureManagement/Microsoft.FeatureManagement.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<PropertyGroup>
<MajorVersion>2</MajorVersion>
<MinorVersion>5</MinorVersion>
<PatchVersion>0</PatchVersion>
<PatchVersion>1</PatchVersion>
</PropertyGroup>

<Import Project="..\..\build\Versioning.props" />
Expand Down