Allow inheritdoc for class constructors with base types #3719

MartyIX · 2023-11-03T13:32:43Z

I'm not sure if the fix is correct or not. Hopefully it is.

codecov · 2023-11-03T14:24:00Z

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (be49652) 97.40% compared to head (6e752bb) 97.40%.
Report is 10 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff            @@
##           master    #3719    +/-   ##
========================================
  Coverage   97.40%   97.40%            
========================================
  Files         914      915     +1     
  Lines      108762   108975   +213     
  Branches     3284     3292     +8     
========================================
+ Hits       105937   106147   +210     
- Misses       1847     1849     +2     
- Partials      978      979     +1

MartyIX · 2023-11-03T19:11:35Z

@bjornhellander I noticed your #3715. Perhaps if you have a minute, could you take a look at this PR please?

MartyIX · 2023-11-04T09:51:53Z

Thinking about the implementation a bit more, it is likely wrong. It is more like a heuristic. I need to investigate a bit more in my MSVS when the inheritdoc attribute works for ctors.

Any guidance would be certainly helpful.

bjornhellander · 2023-11-06T19:59:07Z

My understanding is that the signature has to match a constructor from a base class for the inheritdoc element to be ok.

MartyIX · 2023-11-06T21:04:51Z

Yeah, based on my playing with code, it seems to be the case.

Is there possibly some useful method for getting "constructor with the same signature"? Or does one have to implement it from scratch?

edit: Maybe this https://stackoverflow.com/questions/66113790/how-to-check-if-two-methods-match-signature-via-roslyn will be helpful.

bjornhellander · 2023-11-07T07:05:16Z

I am not aware of any nice utility methods for this.

MartyIX · 2023-11-07T14:05:37Z

@sharwell Any feedback please how you would approach it?

...yzers/StyleCop.Analyzers/DocumentationRules/SA1648InheritDocMustBeUsedWithInheritingClass.cs

bjornhellander · 2023-11-11T07:51:08Z

...yzers/StyleCop.Analyzers/DocumentationRules/SA1648InheritDocMustBeUsedWithInheritingClass.cs

+                {
+                    INamedTypeSymbol baseType = enclosingNamedTypeSymbol.BaseType;
+
+                    if (baseType.SpecialType != SpecialType.System_Object)


Do we really want it to trigger for this case? Maybe not the best documentation, but the use of inheritdoc seems to be correct:

What do you think, @sharwell?

I have added support for this case to follow the VS approach.

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1648UnitTests.cs

...yzers/StyleCop.Analyzers/DocumentationRules/SA1648InheritDocMustBeUsedWithInheritingClass.cs

bjornhellander · 2023-11-11T08:35:01Z

Apart from my question about inheriting from Object, I think the analyzer changes look correct. I would just like to see more tests and improved readability. 👍

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1648UnitTests.cs

This reverts commit 50a5fbf.

...yzers/StyleCop.Analyzers/DocumentationRules/SA1648InheritDocMustBeUsedWithInheritingClass.cs

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1648UnitTests.cs

...yzers/StyleCop.Analyzers/DocumentationRules/SA1648InheritDocMustBeUsedWithInheritingClass.cs

azure-pipelines.yml

bjornhellander · 2023-12-15T17:40:11Z

When you are done with everything mentioned so far, ping sharwell. 👍

# Conflicts: # azure-pipelines.yml

MartyIX · 2023-12-16T21:25:35Z

@sharwell Could I ask for some feedback please?

sharwell · 2023-12-19T19:28:06Z

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1648UnitTests.cs

 namespace StyleCop.Analyzers.Test.DocumentationRules
 {
    using System.Threading;
    using System.Threading.Tasks;
    using Microsoft.CodeAnalysis.Testing;
+    using Microsoft.VisualBasic.Devices;


😕 Is this needed?

That's on Visual Studio. Not me. Obviously. ;) Removed.

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1648UnitTests.cs

...yzers/StyleCop.Analyzers/DocumentationRules/SA1648InheritDocMustBeUsedWithInheritingClass.cs

…20) [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [StyleCop.Analyzers](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers) | `1.2.0-beta.507` -> `1.2.0-beta.556` | [![age](https://developer.mend.io/api/mc/badges/age/nuget/StyleCop.Analyzers/1.2.0-beta.556?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/nuget/StyleCop.Analyzers/1.2.0-beta.556?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/nuget/StyleCop.Analyzers/1.2.0-beta.507/1.2.0-beta.556?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/StyleCop.Analyzers/1.2.0-beta.507/1.2.0-beta.556?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>DotNetAnalyzers/StyleCopAnalyzers (StyleCop.Analyzers)</summary> ### [`v1.2.0-beta.556`](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/releases/tag/1.2.0-beta.556) [Compare Source](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.553...1.2.0-beta.556) #### What's Changed - Update SA1011 to forbid trailing space before the end of a switch case by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3674 - Rewrite IOperationWrapper as a wrapper structure around IOperation by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3611 - Update SA1202 to support interfaces (C# 8) and records (C# 9, 10) by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3694 - Update documentation for SA1308 to also mention prefix "t\_" by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3697 - Update SA1642 and its code fix to handle record structs correctly by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3696 - Update dependencies by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3700 - Mark several test classes as partial by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3702 - Add missing test files and fix inheritance by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3703 - Generate and validate derived test classes by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3704 - Update SA1011 to not require space before a range operator by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3709 - Update SA1131 to treat methods as constants by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3710 - Avoid allocations in CanWrap... methods by [@martin-strecker-sonarsource](https://togithub.com/martin-strecker-sonarsource) in [DotNetAnalyzers/StyleCopAnalyzers#3711 - Update SA1648 to accept inheritdoc on members implemented from static abstract/virtual interface members by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3715 - Update SA1600 to also handle records by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3725 - Update SA1119 to allow parenthesis around a ref ternary conditional expression when it is the left-hand side of an assigment by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3737 - Update SA1119 to allow parenthesized switch expressions followed by an invocation by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3733 - Add c# 12 test project by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3734 - Run tests in parallel jobs by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3740 - Update SA1010 to accept whitespace before collection initializers by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3745 - Update SA1513 to not require a blank line if the closing brace is at the end of a collection expression by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3746 - Update SA1118 to allow multi-line collection expressions by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3749 - Update SA1009 to require a space after the closing parenthesis if it is followed by ++ or -- from a prefix unary expression by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3750 - Update SA1008 to allow space before the opening parenthesis of a using alias definition of a tuple type by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3748 - Update documentation for SA1102 to contain compilable code examples by [@arphox](https://togithub.com/arphox) in [DotNetAnalyzers/StyleCopAnalyzers#3755 - Update SA1008 to not crash if there is no previous token by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3741 - Change default value of test property CodeActionValidationMode to SemanticStructure instead of None and update so that tests still pass by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3753 - Allow inheritdoc for class constructors with base types by [@MartyIX](https://togithub.com/MartyIX) in [DotNetAnalyzers/StyleCopAnalyzers#3719 - Fix that SA1134 Fix All maybe non-deterministic by [@pdelvo](https://togithub.com/pdelvo) in [DotNetAnalyzers/StyleCopAnalyzers#2853 - Coverage improvements by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3675 - Fix SA1131 to not treat "complex" expressions as a literal by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3760 #### New Contributors - [@martin-strecker-sonarsource](https://togithub.com/martin-strecker-sonarsource) made their first contribution in [DotNetAnalyzers/StyleCopAnalyzers#3711 - [@arphox](https://togithub.com/arphox) made their first contribution in [DotNetAnalyzers/StyleCopAnalyzers#3755 - [@MartyIX](https://togithub.com/MartyIX) made their first contribution in [DotNetAnalyzers/StyleCopAnalyzers#3719 **Full Changelog**: DotNetAnalyzers/StyleCopAnalyzers@1.2.0-beta.507...1.2.0-beta.556 ### [`v1.2.0-beta.553`](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/releases/tag/1.2.0-beta.553) [Compare Source](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.507...1.2.0-beta.553) ##### What's Changed - Update SA1011 to forbid trailing space before the end of a switch case by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3674 - Rewrite IOperationWrapper as a wrapper structure around IOperation by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3611 - Update SA1202 to support interfaces (C# 8) and records (C# 9, 10) by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3694 - Update documentation for SA1308 to also mention prefix "t\_" by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3697 - Update SA1642 and its code fix to handle record structs correctly by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3696 - Update dependencies by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3700 - Mark several test classes as partial by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3702 - Add missing test files and fix inheritance by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3703 - Generate and validate derived test classes by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3704 - Update SA1011 to not require space before a range operator by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3709 - Update SA1131 to treat methods as constants by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3710 - Avoid allocations in CanWrap... methods by [@martin-strecker-sonarsource](https://togithub.com/martin-strecker-sonarsource) in [DotNetAnalyzers/StyleCopAnalyzers#3711 - Update SA1648 to accept inheritdoc on members implemented from static abstract/virtual interface members by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3715 - Update SA1600 to also handle records by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3725 - Update SA1119 to allow parenthesis around a ref ternary conditional expression when it is the left-hand side of an assigment by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3737 - Update SA1119 to allow parenthesized switch expressions followed by an invocation by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3733 - Add c# 12 test project by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3734 - Run tests in parallel jobs by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3740 - Update SA1010 to accept whitespace before collection initializers by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3745 - Update SA1513 to not require a blank line if the closing brace is at the end of a collection expression by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3746 - Update SA1118 to allow multi-line collection expressions by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3749 - Update SA1009 to require a space after the closing parenthesis if it is followed by ++ or -- from a prefix unary expression by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3750 - Update SA1008 to allow space before the opening parenthesis of a using alias definition of a tuple type by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3748 - Update documentation for SA1102 to contain compilable code examples by [@arphox](https://togithub.com/arphox) in [DotNetAnalyzers/StyleCopAnalyzers#3755 - Update SA1008 to not crash if there is no previous token by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3741 - Change default value of test property CodeActionValidationMode to SemanticStructure instead of None and update so that tests still pass by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3753 - Allow inheritdoc for class constructors with base types by [@MartyIX](https://togithub.com/MartyIX) in [DotNetAnalyzers/StyleCopAnalyzers#3719 - Fix that SA1134 Fix All maybe non-deterministic by [@pdelvo](https://togithub.com/pdelvo) in [DotNetAnalyzers/StyleCopAnalyzers#2853 - Coverage improvements by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3675 ##### New Contributors - [@martin-strecker-sonarsource](https://togithub.com/martin-strecker-sonarsource) made their first contribution in [DotNetAnalyzers/StyleCopAnalyzers#3711 - [@arphox](https://togithub.com/arphox) made their first contribution in [DotNetAnalyzers/StyleCopAnalyzers#3755 - [@MartyIX](https://togithub.com/MartyIX) made their first contribution in [DotNetAnalyzers/StyleCopAnalyzers#3719 **Full Changelog**: DotNetAnalyzers/StyleCopAnalyzers@1.2.0-beta.507...1.2.0-beta.553 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 9pm,before 6am" in timezone Europe/Zurich, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/smartive/cas-fee-adv-mumble-api).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

…591) [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [StyleCop.Analyzers](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers) | `1.2.0-beta.507` -> `1.2.0-beta.556` | [![age](https://developer.mend.io/api/mc/badges/age/nuget/StyleCop.Analyzers/1.2.0-beta.556?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/nuget/StyleCop.Analyzers/1.2.0-beta.556?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/nuget/StyleCop.Analyzers/1.2.0-beta.507/1.2.0-beta.556?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/StyleCop.Analyzers/1.2.0-beta.507/1.2.0-beta.556?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>DotNetAnalyzers/StyleCopAnalyzers (StyleCop.Analyzers)</summary> ### [`v1.2.0-beta.556`](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/releases/tag/1.2.0-beta.556) [Compare Source](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.553...1.2.0-beta.556) #### What's Changed - Update SA1011 to forbid trailing space before the end of a switch case by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3674 - Rewrite IOperationWrapper as a wrapper structure around IOperation by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3611 - Update SA1202 to support interfaces (C# 8) and records (C# 9, 10) by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3694 - Update documentation for SA1308 to also mention prefix "t\_" by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3697 - Update SA1642 and its code fix to handle record structs correctly by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3696 - Update dependencies by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3700 - Mark several test classes as partial by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3702 - Add missing test files and fix inheritance by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3703 - Generate and validate derived test classes by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3704 - Update SA1011 to not require space before a range operator by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3709 - Update SA1131 to treat methods as constants by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3710 - Avoid allocations in CanWrap... methods by [@martin-strecker-sonarsource](https://togithub.com/martin-strecker-sonarsource) in [DotNetAnalyzers/StyleCopAnalyzers#3711 - Update SA1648 to accept inheritdoc on members implemented from static abstract/virtual interface members by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3715 - Update SA1600 to also handle records by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3725 - Update SA1119 to allow parenthesis around a ref ternary conditional expression when it is the left-hand side of an assigment by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3737 - Update SA1119 to allow parenthesized switch expressions followed by an invocation by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3733 - Add c# 12 test project by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3734 - Run tests in parallel jobs by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3740 - Update SA1010 to accept whitespace before collection initializers by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3745 - Update SA1513 to not require a blank line if the closing brace is at the end of a collection expression by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3746 - Update SA1118 to allow multi-line collection expressions by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3749 - Update SA1009 to require a space after the closing parenthesis if it is followed by ++ or -- from a prefix unary expression by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3750 - Update SA1008 to allow space before the opening parenthesis of a using alias definition of a tuple type by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3748 - Update documentation for SA1102 to contain compilable code examples by [@arphox](https://togithub.com/arphox) in [DotNetAnalyzers/StyleCopAnalyzers#3755 - Update SA1008 to not crash if there is no previous token by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3741 - Change default value of test property CodeActionValidationMode to SemanticStructure instead of None and update so that tests still pass by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3753 - Allow inheritdoc for class constructors with base types by [@MartyIX](https://togithub.com/MartyIX) in [DotNetAnalyzers/StyleCopAnalyzers#3719 - Fix that SA1134 Fix All maybe non-deterministic by [@pdelvo](https://togithub.com/pdelvo) in [DotNetAnalyzers/StyleCopAnalyzers#2853 - Coverage improvements by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3675 - Fix SA1131 to not treat "complex" expressions as a literal by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3760 #### New Contributors - [@martin-strecker-sonarsource](https://togithub.com/martin-strecker-sonarsource) made their first contribution in [DotNetAnalyzers/StyleCopAnalyzers#3711 - [@arphox](https://togithub.com/arphox) made their first contribution in [DotNetAnalyzers/StyleCopAnalyzers#3755 - [@MartyIX](https://togithub.com/MartyIX) made their first contribution in [DotNetAnalyzers/StyleCopAnalyzers#3719 **Full Changelog**: DotNetAnalyzers/StyleCopAnalyzers@1.2.0-beta.507...1.2.0-beta.556 ### [`v1.2.0-beta.553`](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/releases/tag/1.2.0-beta.553) [Compare Source](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.507...1.2.0-beta.553) ##### What's Changed - Update SA1011 to forbid trailing space before the end of a switch case by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3674 - Rewrite IOperationWrapper as a wrapper structure around IOperation by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3611 - Update SA1202 to support interfaces (C# 8) and records (C# 9, 10) by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3694 - Update documentation for SA1308 to also mention prefix "t\_" by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3697 - Update SA1642 and its code fix to handle record structs correctly by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3696 - Update dependencies by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3700 - Mark several test classes as partial by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3702 - Add missing test files and fix inheritance by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3703 - Generate and validate derived test classes by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3704 - Update SA1011 to not require space before a range operator by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3709 - Update SA1131 to treat methods as constants by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3710 - Avoid allocations in CanWrap... methods by [@martin-strecker-sonarsource](https://togithub.com/martin-strecker-sonarsource) in [DotNetAnalyzers/StyleCopAnalyzers#3711 - Update SA1648 to accept inheritdoc on members implemented from static abstract/virtual interface members by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3715 - Update SA1600 to also handle records by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3725 - Update SA1119 to allow parenthesis around a ref ternary conditional expression when it is the left-hand side of an assigment by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3737 - Update SA1119 to allow parenthesized switch expressions followed by an invocation by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3733 - Add c# 12 test project by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3734 - Run tests in parallel jobs by [@sharwell](https://togithub.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3740 - Update SA1010 to accept whitespace before collection initializers by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3745 - Update SA1513 to not require a blank line if the closing brace is at the end of a collection expression by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3746 - Update SA1118 to allow multi-line collection expressions by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3749 - Update SA1009 to require a space after the closing parenthesis if it is followed by ++ or -- from a prefix unary expression by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3750 - Update SA1008 to allow space before the opening parenthesis of a using alias definition of a tuple type by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3748 - Update documentation for SA1102 to contain compilable code examples by [@arphox](https://togithub.com/arphox) in [DotNetAnalyzers/StyleCopAnalyzers#3755 - Update SA1008 to not crash if there is no previous token by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3741 - Change default value of test property CodeActionValidationMode to SemanticStructure instead of None and update so that tests still pass by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3753 - Allow inheritdoc for class constructors with base types by [@MartyIX](https://togithub.com/MartyIX) in [DotNetAnalyzers/StyleCopAnalyzers#3719 - Fix that SA1134 Fix All maybe non-deterministic by [@pdelvo](https://togithub.com/pdelvo) in [DotNetAnalyzers/StyleCopAnalyzers#2853 - Coverage improvements by [@bjornhellander](https://togithub.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3675 ##### New Contributors - [@martin-strecker-sonarsource](https://togithub.com/martin-strecker-sonarsource) made their first contribution in [DotNetAnalyzers/StyleCopAnalyzers#3711 - [@arphox](https://togithub.com/arphox) made their first contribution in [DotNetAnalyzers/StyleCopAnalyzers#3755 - [@MartyIX](https://togithub.com/MartyIX) made their first contribution in [DotNetAnalyzers/StyleCopAnalyzers#3719 **Full Changelog**: DotNetAnalyzers/StyleCopAnalyzers@1.2.0-beta.507...1.2.0-beta.553 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 4am" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/ThorstenSauter/NoPlan).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Allow inheritdoc for constructors with base types

2d5a62f

MartyIX changed the title ~~Allow inheritdoc for constructors with base types~~ Allow inheritdoc for class constructors with base types Nov 3, 2023

Fix

7cd2b05

Another approach

ef223ab

Improve implementation

d58dede

bjornhellander reviewed Nov 11, 2023

View reviewed changes

...yzers/StyleCop.Analyzers/DocumentationRules/SA1648InheritDocMustBeUsedWithInheritingClass.cs Outdated Show resolved Hide resolved

bjornhellander reviewed Nov 11, 2023

View reviewed changes

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1648UnitTests.cs Outdated Show resolved Hide resolved

bjornhellander reviewed Nov 11, 2023

View reviewed changes

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1648UnitTests.cs Outdated Show resolved Hide resolved

bjornhellander reviewed Nov 11, 2023

View reviewed changes

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1648UnitTests.cs Outdated Show resolved Hide resolved

bjornhellander reviewed Nov 11, 2023

View reviewed changes

...yzers/StyleCop.Analyzers/DocumentationRules/SA1648InheritDocMustBeUsedWithInheritingClass.cs Outdated Show resolved Hide resolved

MartyIX added 5 commits November 11, 2023 11:14

Remove #nullable enable from the test

836540c

SA1648InheritDocMustBeUsedWithInheritingClass: Enable NRT

62237f3

Move up and use declaredSymbol

49d59ce

Split tests

b7d10a8

Address review comments

fd402ad

MartyIX commented Nov 11, 2023

View reviewed changes

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1648UnitTests.cs Show resolved Hide resolved

MartyIX commented Nov 11, 2023

View reviewed changes

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1648UnitTests.cs Show resolved Hide resolved

MartyIX added 4 commits November 29, 2023 08:23

Add a test for ArgumentException (type from a different assembly)

5ecef98

Test records as well

31643cf

Struct case

50a5fbf

Merge branch 'master' into issue2575

3ca55e3

Revert "Struct case"

182e0a7

This reverts commit 50a5fbf.

bjornhellander mentioned this pull request Dec 3, 2023

Remove ConfigureAwait(false) in tests? #3742

Open

MartyIX requested a review from bjornhellander December 5, 2023 15:38

bjornhellander reviewed Dec 9, 2023

View reviewed changes

...yzers/StyleCop.Analyzers/DocumentationRules/SA1648InheritDocMustBeUsedWithInheritingClass.cs Outdated Show resolved Hide resolved

bjornhellander reviewed Dec 9, 2023

View reviewed changes

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1648UnitTests.cs Show resolved Hide resolved

bjornhellander reviewed Dec 9, 2023

View reviewed changes

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1648UnitTests.cs Show resolved Hide resolved

bjornhellander reviewed Dec 9, 2023

View reviewed changes

...yzers/StyleCop.Analyzers/DocumentationRules/SA1648InheritDocMustBeUsedWithInheritingClass.cs Outdated Show resolved Hide resolved

MartyIX and others added 5 commits December 9, 2023 22:04

Simplify

0ebb990

Simplify?

7183ec0

more tests

db794b0

Merge branch 'master' into issue2575

858e7a1

Increase test timeout to 80 minutes

80804ab

MartyIX requested a review from bjornhellander December 13, 2023 10:21

bjornhellander reviewed Dec 15, 2023

View reviewed changes

azure-pipelines.yml Outdated Show resolved Hide resolved

Merge branch 'master' into issue2575

3800377

# Conflicts: # azure-pipelines.yml

sharwell reviewed Dec 19, 2023

View reviewed changes

Feedback

6e752bb

sharwell approved these changes Dec 19, 2023

View reviewed changes

sharwell merged commit 69d477f into DotNetAnalyzers:master Dec 19, 2023
19 checks passed

sharwell added this to the 1.2-beta.next milestone Dec 19, 2023

MartyIX deleted the issue2575 branch December 19, 2023 20:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow inheritdoc for class constructors with base types #3719

Allow inheritdoc for class constructors with base types #3719

MartyIX commented Nov 3, 2023

codecov bot commented Nov 3, 2023 •

edited

MartyIX commented Nov 3, 2023

MartyIX commented Nov 4, 2023 •

edited

bjornhellander commented Nov 6, 2023

MartyIX commented Nov 6, 2023 •

edited

bjornhellander commented Nov 7, 2023

MartyIX commented Nov 7, 2023

bjornhellander Nov 11, 2023 •

edited

MartyIX Nov 11, 2023

bjornhellander commented Nov 11, 2023

bjornhellander commented Dec 15, 2023

MartyIX commented Dec 16, 2023

sharwell Dec 19, 2023

MartyIX Dec 19, 2023

Allow inheritdoc for class constructors with base types #3719

Allow inheritdoc for class constructors with base types #3719

Conversation

MartyIX commented Nov 3, 2023

codecov bot commented Nov 3, 2023 • edited

Codecov Report

MartyIX commented Nov 3, 2023

MartyIX commented Nov 4, 2023 • edited

bjornhellander commented Nov 6, 2023

MartyIX commented Nov 6, 2023 • edited

bjornhellander commented Nov 7, 2023

MartyIX commented Nov 7, 2023

bjornhellander Nov 11, 2023 • edited

Choose a reason for hiding this comment

MartyIX Nov 11, 2023

Choose a reason for hiding this comment

bjornhellander commented Nov 11, 2023

bjornhellander commented Dec 15, 2023

MartyIX commented Dec 16, 2023

sharwell Dec 19, 2023

Choose a reason for hiding this comment

MartyIX Dec 19, 2023

Choose a reason for hiding this comment

codecov bot commented Nov 3, 2023 •

edited

MartyIX commented Nov 4, 2023 •

edited

MartyIX commented Nov 6, 2023 •

edited

bjornhellander Nov 11, 2023 •

edited