Skip to content

Commit 1283d7d

Browse files
authored
Unified editor config with consumer to provide more common support. (#275)
* Includes updates to StyleCop.json - This enables doc check for interfaces - Sadly this applies to any interface even internal ones. If any member of the interface has XML docs it will trigger an issue that the whole thing doesn't have docs.
1 parent 63b7465 commit 1283d7d

File tree

3 files changed

+7
-2
lines changed

3 files changed

+7
-2
lines changed

.editorconfig

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ dotnet_style_prefer_auto_properties = true:error
161161
dotnet_style_object_initializer = true:suggestion
162162
dotnet_style_collection_initializer = true:warning
163163
dotnet_style_prefer_simplified_boolean_expressions = true:error
164-
dotnet_style_prefer_conditional_expression_over_assignment = true:warning
164+
dotnet_style_prefer_conditional_expression_over_assignment = true:suggestion
165165
dotnet_style_prefer_conditional_expression_over_return = true:warning
166166
dotnet_style_explicit_tuple_names = true:warning
167167
dotnet_style_operator_placement_when_wrapping = beginning_of_line
@@ -1608,3 +1608,6 @@ dotnet_diagnostic.SA1652.severity = warning
16081608

16091609
dotnet_diagnostic.SX1101.severity = error
16101610

1611+
1612+
# IDE0045: Convert to conditional expression
1613+
dotnet_diagnostic.IDE0045.severity = suggestion

src/Ubiquity.NET.Llvm/IGlobalHandleOwner.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
namespace Ubiquity.NET.Llvm
88
{
99
[SuppressMessage( "StyleCop.CSharp.DocumentationRules", "SA1649:File name should match first type name", Justification = "Closely related interfaces" )]
10+
[SuppressMessage( "StyleCop.CSharp.DocumentationRules", "SA1600:Elements should be documented", Justification = "Internal Interface" )]
1011
internal interface IHandleWrapper<THandle>
1112
{
1213
/// <summary>Gets the handle for this wrapper</summary>
@@ -19,6 +20,7 @@ internal interface IHandleWrapper<THandle>
1920
internal THandle Handle { get; }
2021
}
2122

23+
[SuppressMessage( "StyleCop.CSharp.DocumentationRules", "SA1600:Elements should be documented", Justification = "Internal Interface" )]
2224
internal interface IGlobalHandleOwner<THandle>
2325
: IDisposable
2426
where THandle : GlobalHandleBase

stylecop.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
"companyName": "Ubiquity.NET Contributors",
3636
"headerDecoration": "-----------------------------------------------------------------------",
3737
"documentExposedElements": true,
38-
"documentInterfaces": false,
38+
"documentInterfaces": true,
3939
"documentInternalElements": false,
4040
"documentPrivateElements": false,
4141
"documentPrivateFields": false,

0 commit comments

Comments
 (0)