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

Jump to bottom

SA1604 reported for non-exposed members even when documentInternalElements is false #2443

Closed
m-akinc opened this issue Jun 19, 2017 · 1 comment
Closed

SA1604 reported for non-exposed members even when documentInternalElements is false #2443

m-akinc opened this issue Jun 19, 2017 · 1 comment
Assignees
@sharwell
Labels
bug fixed
Milestone
1.1.0 Beta 4

Comments

@m-akinc
Copy link

m-akinc commented Jun 19, 2017 •
edited by sharwell

When the documentInternalElements or documentPrivateElements option is set to false, SA1604:ElementDocumentationMustHaveSummary should never be reported for those non-public members which are exempted from the documentation requirement. As expected, there is no reported violation for:

private int Foo()

However, it is reported in the following examples:

///
private int Foo()

/**
 *
 */
private int Foo()
@m-akinc m-akinc changed the title SA1604 reported for non-exposed members even when documentInternalMembers is false SA1604 reported for non-exposed members even when documentInternalMembers is false Jun 19, 2017
@sharwell sharwell added the bug label Jun 20, 2017
@sharwell sharwell added this to the 1.1.0 milestone Jun 20, 2017
@sharwell sharwell self-assigned this Jun 20, 2017
sharwell added a commit to sharwell/StyleCopAnalyzers that referenced this issue Jun 20, 2017
@sharwell
Update SA1604 to ignore elements that do not require documentation
5400cf3 
Fixes DotNetAnalyzers#2443
@sharwell sharwell mentioned this issue Jun 20, 2017
Merged
@sharwell
Copy link
Member

📝 This was filed per a request in #2361.

@sharwell sharwell mentioned this issue Jun 20, 2017
Closed
@sharwell sharwell changed the title SA1604 reported for non-exposed members even when documentInternalMembers is false SA1604 reported for non-exposed members even when documentInternalElements is false Jun 20, 2017
This was referenced Jun 20, 2017
Closed
Closed
Closed
@sharwell sharwell modified the milestones: 1.1.0, 1.1.0 Beta 4 Jun 20, 2017
@peteroupc peteroupc mentioned this issue Jun 25, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sharwell sharwell

Labels
bug fixed
Projects
None yet
Milestone
1.1.0 Beta 4
Development

No branches or pull requests
2 participants
@sharwell @m-akinc