Seana71/fix comments#84
Merged
jkoritzinsky merged 2 commits intoSharpGenTools:masterfrom Sep 21, 2018
Merged
Conversation
… top level xml and comments nodes were examined, and not the comment children inside comments.
…tyleCop ignores them.
Codecov Report
@@ Coverage Diff @@
## master #84 +/- ##
==========================================
- Coverage 58.51% 58.48% -0.03%
==========================================
Files 150 150
Lines 9148 9156 +8
Branches 1123 1124 +1
==========================================
+ Hits 5353 5355 +2
- Misses 3404 3410 +6
Partials 391 391
Continue to review full report at Codecov.
|
Member
|
Thanks for the fixes! Sorry for not matching the documentation. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This change adds a "// <auto-generated/>" comment at the top of the automatically generated files (functions.cs, etc.) to prevent StyleCop from parsing them and creating hundreds of warnings/errors. StyleCop currently hasn't an easy way to disable processing of selected source files.
Another fix is to the SharpGenExternalDocs processing, wasn't examining the children of the "comments" xml node; the previous code seemed expect the external documentation files were a series of unparented "comment" nodes, which contradicts the SharpGen documentation.