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.

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

Add missing xml comments and fix style analyzer warnings #1451

Closed
nmetulev opened this issue Aug 30, 2017 · 1 comment
Closed

Add missing xml comments and fix style analyzer warnings #1451

nmetulev opened this issue Aug 30, 2017 · 1 comment

Comments

@nmetulev
Copy link
Contributor

we discovered from #1443 that we have many missing xml comments that need to be added and several style issues that should be resolved.

@nmetulev nmetulev added this to the v2.1 milestone Aug 30, 2017
@dotMorten
Copy link
Contributor

Several warnings are created by auto-generated code. If you put <auto-generated> in the comment header, the compiler will ignore warnings in those files. Example of a typical header:

//------------------------------------------------------------------------------
// <auto-generated>
//     This code was generated by a tool.
// *** Warning: Please do not edit as changes will be overwritten. This file is auto generated. ***
// </auto-generated>
//------------------------------------------------------------------------------

https://github.com/StyleCop/StyleCop/blob/3f701f549b5b2cd6dd8dda19866d083022b8da97/Project/Src/StyleCop.CSharp/FileHeader.cs#L104

@nmetulev nmetulev self-assigned this Oct 11, 2017
@ghost ghost locked as resolved and limited conversation to collaborators Nov 26, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants