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

Fix XML Build warnings #128

Closed
milkshakeuk opened this issue Nov 6, 2020 · 5 comments · Fixed by #135 or #137
Closed

Fix XML Build warnings #128

milkshakeuk opened this issue Nov 6, 2020 · 5 comments · Fixed by #135 or #137

Comments

@milkshakeuk
Copy link
Member

Currently when building there are lots of XML comment warnings which need fixing.
A lot of the errors are generated as part of e the code generation so the fix for those will be done in the source generator code.

A sample of the warnings below.

Datatype\ACCIDENTDATA.cs(64,1): warning CS1570: XML comment has badly formed XML -- 'Expected an end tag for element 'summary'.' [C:\DEV\nhapi\src\NHapi.Model.V22_ZSegments\NHapi.Model.V22_ZSegments.csproj]
Segment\ZIN.cs(29,8): warning CS1570: XML comment has badly formed XML -- 'End tag 'p' does not match the start tag 'br'.' [C:\DEV\nhapi\src\NHapi.Model.V22_ZSegments\NHapi.Model.V22_ZSegments.csproj]
Segment\ZIN.cs(34,8): warning CS1570: XML comment has badly formed XML -- 'End tag 'summary' does not match the start tag 'br'.' [C:\DEV\nhapi\src\NHapi.Model.V22_ZSegments\NHapi.Model.V22_ZSegments.csproj]
Segment\ZIN.cs(35,1): warning CS1570: XML comment has badly formed XML -- 'Expected an end tag for element 'br'.' [C:\DEV\nhapi\src\NHapi.Model.V22_ZSegments\NHapi.Model.V22_ZSegments.csproj]        
Segment\ZIN.cs(35,1): warning CS1570: XML comment has badly formed XML -- 'Expected an end tag for element 'p'.' [C:\DEV\nhapi\src\NHapi.Model.V22_ZSegments\NHapi.Model.V22_ZSegments.csproj]
Segment\ZIN.cs(35,1): warning CS1570: XML comment has badly formed XML -- 'Expected an end tag for element 'summary'.' [C:\DEV\nhapi\src\NHapi.Model.V22_ZSegments\NHapi.Model.V22_ZSegments.csproj]   
Datatype\ACCIDENTDATA.cs(37,48): warning CS1573: Parameter 'description' has no matching param tag in the XML comment for 'ACCIDENTDATA.ACCIDENTDATA(IMessage, string)' (but other parameters do) [C:\DEV\nhapi\src\NHapi.Model.V22_ZSegments\NHapi.Model.V22_ZSegments.csproj]
Datatype\ACCIDENTDATA.cs(64,1): warning CS1570: XML comment has badly formed XML -- 'Expected an end tag for element 'summary'.' [C:\DEV\nhapi\src\NHapi.Model.V22_ZSegments\NHapi.Model.V22_ZSegments.csproj]
Segment\ZIN.cs(29,8): warning CS1570: XML comment has badly formed XML -- 'End tag 'p' does not match the start tag 'br'.' [C:\DEV\nhapi\src\NHapi.Model.V22_ZSegments\NHapi.Model.V22_ZSegments.csproj]
Segment\ZIN.cs(34,8): warning CS1570: XML comment has badly formed XML -- 'End tag 'summary' does not match the start tag 'br'.' [C:\DEV\nhapi\src\NHapi.Model.V22_ZSegments\NHapi.Model.V22_ZSegments.csproj]
Segment\ZIN.cs(35,1): warning CS1570: XML comment has badly formed XML -- 'Expected an end tag for element 'br'.' [C:\DEV\nhapi\src\NHapi.Model.V22_ZSegments\NHapi.Model.V22_ZSegments.csproj]
Segment\ZIN.cs(35,1): warning CS1570: XML comment has badly formed XML -- 'Expected an end tag for element 'p'.' [C:\DEV\nhapi\src\NHapi.Model.V22_ZSegments\NHapi.Model.V22_ZSegments.csproj]
Segment\ZIN.cs(35,1): warning CS1570: XML comment has badly formed XML -- 'Expected an end tag for element 'summary'.' [C:\DEV\nhapi\src\NHapi.Model.V22_ZSegments\NHapi.Model.V22_ZSegments.csproj]   
Datatype\ACCIDENTDATA.cs(37,48): warning CS1573: Parameter 'description' has no matching param tag in the XML comment for 'ACCIDENTDATA.ACCIDENTDATA(IMessage, string)' (but other parameters do) [C:\DEV\nhapi\src\NHapi.Model.V22_ZSegments\NHapi.Model.V22_ZSegments.csproj]
@milkshakeuk milkshakeuk added this to the v3.0.0.0 milestone Nov 6, 2020
@milkshakeuk milkshakeuk added this to To Do in NHapi Kanban via automation Nov 6, 2020
@AMCN41R
Copy link
Collaborator

AMCN41R commented Jan 28, 2021

@milkshakeuk - i'll take a look at this if you want

@milkshakeuk
Copy link
Member Author

@AMCN41R thanks!

@AMCN41R
Copy link
Collaborator

AMCN41R commented Jan 28, 2021

@milkshakeuk - will probably tackle this over a number of PRs to make it clear. Here is number 1...

PR 135

@milkshakeuk milkshakeuk moved this from To Do to In Progress in NHapi Kanban Jan 29, 2021
@milkshakeuk milkshakeuk linked a pull request Jan 29, 2021 that will close this issue
milkshakeuk added a commit that referenced this issue Jan 29, 2021
#128 > NHapi.Base > Formatted XML License Comments
@milkshakeuk milkshakeuk linked a pull request Jan 29, 2021 that will close this issue
@AMCN41R
Copy link
Collaborator

AMCN41R commented Jan 30, 2021

@milkshakeuk - Another PR for this... PR 137

I think that covers this issue, but let me know if you want me to do anything else to close this.

@milkshakeuk milkshakeuk linked a pull request Feb 1, 2021 that will close this issue
@milkshakeuk
Copy link
Member Author

Build warnings associated with comments in the code have gone so I'm going to close this.

NHapi Kanban automation moved this from In Progress to Development Done Feb 1, 2021
@milkshakeuk milkshakeuk moved this from Development Done to In Pre-Release in NHapi Kanban Jun 2, 2021
@milkshakeuk milkshakeuk moved this from In Pre-Release to Released in NHapi Kanban Jun 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
2 participants