TimeSource - Updated XML docs with Wiki-links #5901
Conversation
WalkthroughXML documentation remarks and "seealso" tags referencing the NLog Wiki page about Time Source were added to several time source classes. These changes enhance the inline documentation without altering any class functionality, method signatures, logic, or control flow. Changes
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
src/NLog/Time/TimeSource.cs (1)
43-46: Replace raw<a>tag with<see href>and drop the redundant<seealso>
<a>isn’t recognised by the C# XML–doc tool-chain and can surface CS15xx warnings.
Using<see href>is the recommended way to embed external links and renders correctly in IntelliSense / doc generators. The<seealso>that follows points to the exact same URL, so one link is enough.- /// <a href="https://github.com/NLog/NLog/wiki/Time-Source">See NLog Wiki</a> - /// </remarks> - /// <seealso href="https://github.com/NLog/NLog/wiki/Time-Source">Documentation on NLog Wiki</seealso> + /// <see href="https://github.com/NLog/NLog/wiki/Time-Source">NLog Wiki – Time Source</see> + /// </remarks>Run a quick build or grep for
<a href=to confirm the repo stays warning-free.src/NLog/Time/FastUtcTimeSource.cs (1)
41-44: Use<see href>instead of raw<a>and avoid duplicate linkSame rationale as for
TimeSource.cs: avoid potential XML-doc warnings and keep a single canonical link.- /// <a href="https://github.com/NLog/NLog/wiki/Time-Source">See NLog Wiki</a> - /// </remarks> - /// <seealso href="https://github.com/NLog/NLog/wiki/Time-Source">Documentation on NLog Wiki</seealso> + /// <see href="https://github.com/NLog/NLog/wiki/Time-Source">NLog Wiki – Time Source</see> + /// </remarks>src/NLog/Time/FastLocalTimeSource.cs (1)
41-44: Align with XML-doc best practiceSwap
<a>for<see href>and drop the second link for the same reasons stated earlier.- /// <a href="https://github.com/NLog/NLog/wiki/Time-Source">See NLog Wiki</a> - /// </remarks> - /// <seealso href="https://github.com/NLog/NLog/wiki/Time-Source">Documentation on NLog Wiki</seealso> + /// <see href="https://github.com/NLog/NLog/wiki/Time-Source">NLog Wiki – Time Source</see> + /// </remarks>src/NLog/Time/AccurateUtcTimeSource.cs (1)
41-44: Consistent hyperlink markupRecommend the same
<see href>swap and removal of the duplicate<seealso>.- /// <a href="https://github.com/NLog/NLog/wiki/Time-Source">See NLog Wiki</a> - /// </remarks> - /// <seealso href="https://github.com/NLog/NLog/wiki/Time-Source">Documentation on NLog Wiki</seealso> + /// <see href="https://github.com/NLog/NLog/wiki/Time-Source">NLog Wiki – Time Source</see> + /// </remarks>src/NLog/Time/CachedTimeSource.cs (1)
41-44: Tidy up XML documentation linkFor uniformity across the codebase, switch to
<see href>and remove the extra<seealso>.- /// <a href="https://github.com/NLog/NLog/wiki/Time-Source">See NLog Wiki</a> - /// </remarks> - /// <seealso href="https://github.com/NLog/NLog/wiki/Time-Source">Documentation on NLog Wiki</seealso> + /// <see href="https://github.com/NLog/NLog/wiki/Time-Source">NLog Wiki – Time Source</see> + /// </remarks>src/NLog/Time/AccurateLocalTimeSource.cs (1)
41-44: Prefer<see href="…">over raw<a>to stay XML-doc compliant and avoid duplicate linksRaw HTML anchors aren’t interpreted by most XML-doc toolchains (IntelliSense, DocFX, etc.) and will render as plain text or trigger warnings, whereas
<see>/<seealso>are first-class.
You already expose the same URL via<seealso>, so the anchor in<remarks>is redundant.-/// <remarks> -/// <a href="https://github.com/NLog/NLog/wiki/Time-Source">See NLog Wiki</a> -/// </remarks> +/// <remarks> +/// <see href="https://github.com/NLog/NLog/wiki/Time-Source">NLog Wiki – Time Source</see> +/// </remarks>This keeps the docs cleaner and compiler-friendly.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
src/NLog/Time/AccurateLocalTimeSource.cs(1 hunks)src/NLog/Time/AccurateUtcTimeSource.cs(1 hunks)src/NLog/Time/CachedTimeSource.cs(1 hunks)src/NLog/Time/FastLocalTimeSource.cs(1 hunks)src/NLog/Time/FastUtcTimeSource.cs(1 hunks)src/NLog/Time/TimeSource.cs(1 hunks)
|
No description provided.