Severity: Info
File: src/Servy.Core/Logging/EventLogReader.cs line 44
Description:
The XML-doc <returns> tag on the private MapToDto helper is truncated mid-word and the </returns> closing tag is missing:
/// <returns>A populated <see cref="ServyEventLogEntry"/> containing the formatted messa
private static ServyEventLogEntry MapToDto(EventRecord evt)
C# doc comments with unclosed tags typically still compile but surface as SA1619 / CS1570-family warnings during doc generation and are dropped from the produced XML doc file. The description itself ends at "formatted messa".
Suggested fix:
Complete the sentence and close the tag:
/// <returns>
/// A populated <see cref="ServyEventLogEntry"/> containing the formatted message,
/// event id, level, provider name and timestamp pulled from <paramref name="evt"/>.
/// </returns>
While in the file, a quick sweep for other /// blocks whose last line doesn't end in a closing tag would catch any other truncation left by the same editor session. A GenerateDocumentationFile=true in the project file plus TreatWarningsAsErrors=true would prevent this class of accident in future.
Severity: Info
File:
src/Servy.Core/Logging/EventLogReader.csline 44Description:
The XML-doc
<returns>tag on the privateMapToDtohelper is truncated mid-word and the</returns>closing tag is missing:C# doc comments with unclosed tags typically still compile but surface as SA1619 / CS1570-family warnings during doc generation and are dropped from the produced XML doc file. The description itself ends at "formatted messa".
Suggested fix:
Complete the sentence and close the tag:
While in the file, a quick sweep for other
///blocks whose last line doesn't end in a closing tag would catch any other truncation left by the same editor session. AGenerateDocumentationFile=truein the project file plusTreatWarningsAsErrors=truewould prevent this class of accident in future.