Severity: Info (cosmetic, but breaks XML doc generation for that constructor)
File / line: src/Servy.Service/Service.cs line 219
Code:
/// <param name="pathValidator">The path validator.</param>
/// <param name="serviceRepository">The service repository.</param>
/// <param name="processHelper">The process helper.</param>
/// <param name="processKiller">The process killer.</param>
/// <pa // <-- truncated tag
/// <remarks>
/// <b>NOTE:</b> This constructor is primarily intended for <b>Unit Testing</b> ...
What's wrong: The doc-comment block on the unit-test / IoC constructor (public Service(IServiceHelper, IServyLogger, IStreamWriterFactory, ITimerFactory, IProcessFactory, IPathValidator, IServiceRepository, IProcessHelper, IProcessKiller)) ends with a partial <pa tag — a leftover from an aborted edit, almost certainly meant to be a <param name="processKiller"> (or similar) line that never finished. There is no <summary> either; the <remarks> block is the only descriptive text.
The C# compiler tolerates malformed doc-comment XML (it just skips it), so no warning is emitted, but Sandcastle / docfx / IDE IntelliSense will silently drop the comment for this constructor.
Suggested fix: Either delete line 219 outright, or replace it with the missing <summary> block + finish the <param> list. A minimal repair:
/// <param name="processKiller">The process killer.</param>
/// <summary>
/// Initializes a new instance of the <see cref="Service"/> class with full dependency injection.
/// </summary>
/// <remarks>
/// ...
(The summary already exists higher in the file, around line 207–209 — that one is for the FULL-DI ctor; this finding is the second DI ctor at line 232 that has the broken <pa.)
This is unrelated to #859 (HandleLogWriters local-fn doc — different location / different problem).
Severity: Info (cosmetic, but breaks XML doc generation for that constructor)
File / line:
src/Servy.Service/Service.csline 219Code:
What's wrong: The doc-comment block on the unit-test / IoC constructor (
public Service(IServiceHelper, IServyLogger, IStreamWriterFactory, ITimerFactory, IProcessFactory, IPathValidator, IServiceRepository, IProcessHelper, IProcessKiller)) ends with a partial<patag — a leftover from an aborted edit, almost certainly meant to be a<param name="processKiller">(or similar) line that never finished. There is no<summary>either; the<remarks>block is the only descriptive text.The C# compiler tolerates malformed doc-comment XML (it just skips it), so no warning is emitted, but Sandcastle / docfx / IDE IntelliSense will silently drop the comment for this constructor.
Suggested fix: Either delete line 219 outright, or replace it with the missing
<summary>block + finish the<param>list. A minimal repair:(The summary already exists higher in the file, around line 207–209 — that one is for the FULL-DI ctor; this finding is the second DI ctor at line 232 that has the broken
<pa.)This is unrelated to #859 (HandleLogWriters local-fn doc — different location / different problem).