Skip to content

Tons of warning CS1587: XML comment is not placed on a valid language element #474

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
Closed
angularsen opened this issue Sep 12, 2018 · 3 comments
Closed

Tons of warning CS1587: XML comment is not placed on a valid language element #474

angularsen opened this issue Sep 12, 2018 · 3 comments
Labels
difficulty-easy good first issue

Comments

@angularsen
Copy link
Owner

angularsen commented Sep 12, 2018 •
edited
Loading

21000 warnings total! Maybe not all of them are this warning, but it seems like the vast majority are.
Not sure when this was introduced, but I guess it is fairly recent.

https://ci.appveyor.com/project/angularsen/unitsnet/build/844

A small sample:

C:\projects\unitsnet\Common\GeneratedCode\Quantities\SolidAngle.Common.g.cs(480,9): warning CS1587: XML comment is not placed on a valid language element [C:\projects\unitsnet\UnitsNet\UnitsNet.Signed.csproj]
C:\projects\unitsnet\Common\GeneratedCode\Quantities\SpecificEnergy.Common.g.cs(628,9): warning CS1587: XML comment is not placed on a valid language element [C:\projects\unitsnet\UnitsNet\UnitsNet.Signed.csproj]
C:\projects\unitsnet\Common\GeneratedCode\Quantities\SpecificEntropy.Common.g.cs(628,9): warning CS1587: XML comment is not placed on a valid language element [C:\projects\unitsnet\UnitsNet\UnitsNet.Signed.csproj]
C:\projects\unitsnet\Common\GeneratedCode\Quantities\SpecificVolume.Common.g.cs(502,9): warning CS1587: XML comment is not placed on a valid language element [C:\projects\unitsnet\UnitsNet\UnitsNet.Signed.csproj]
C:\projects\unitsnet\Common\GeneratedCode\Quantities\SpecificWeight.Common.g.cs(817,9): warning CS1587: XML comment is not placed on a valid language element [C:\projects\unitsnet\UnitsNet\UnitsNet.Signed.csproj]
C:\projects\unitsnet\Common\GeneratedCode\Quantities\Speed.Common.g.cs(1132,9): warning CS1587: XML comment is not placed on a valid language element [C:\projects\unitsnet\UnitsNet\UnitsNet.Signed.csproj]
@tmilnthorp
Copy link
Collaborator

I noticed a lot of these while splitting apart the WCR code. Most is from the #if for WCR method signatures interrupting the XML comment for that method.

@angularsen
Copy link
Owner Author

Ah yes, that is probably it. Can it be fixed by moving things around a bit?

@tmilnthorp tmilnthorp mentioned this issue Sep 13, 2018
Merged
@angularsen
Copy link
Owner Author

angularsen commented Sep 28, 2018 •
edited
Loading

This is fixed now it seems, I recently muted thousands of warnings about missing XML doc on public methods/types, and there are none of these warnings anymore and this warning is not muted.

dglozano added a commit to dglozano/UnitsNet that referenced this issue Nov 21, 2021
@dglozano
Move Obsolete attribute in the generator below the summary documentation
c41ebb1 
The [Obsolete] attribute was being generated on top of the XML documentation, which is an invalid location, so I have moved it right after it and before the
[DataContract] attribute.

Related:
 - angularsen#474
dglozano added a commit to dglozano/UnitsNet that referenced this issue Nov 21, 2021
@dglozano
Move Obsolete attribute in the generator below the XML documentation
b11c6ea 
The [Obsolete] attribute was being generated on top of the XML documentation, which is an invalid location, so I have moved it right after it and before the
[DataContract] attribute.

Related:
 - angularsen#474
dglozano added a commit to dglozano/UnitsNet that referenced this issue Nov 23, 2021
@dglozano
Move Obsolete attribute in the generator below the XML documentation
c1aca3c 
The [Obsolete] attribute was being generated on top of the XML documentation, which is an invalid location, so I have moved it right after it and before the
[DataContract] attribute.

Related:
 - angularsen#474
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
difficulty-easy good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@angularsen @tmilnthorp