From b543ec6fb8f9e2355ffa13f5a1841615bd2122e6 Mon Sep 17 00:00:00 2001 From: rameel Date: Fri, 6 Nov 2026 00:00:53 +0500 Subject: [PATCH] docs: clarify XML comments --- .../Serialization/HtmxLocationOptionsJsonView.cs | 2 +- .../TagHelpers/HtmxConfigTagHelper.cs | 2 +- .../TagHelpers/HtmxHeadersTagHelper.cs | 2 +- .../TagHelpers/HtmxRequestTagHelper.cs | 8 ++++---- src/Ramstack.HtmxToolkit/TagHelpers/HtmxUrlTagHelper.cs | 2 +- src/Ramstack.HtmxToolkit/TagHelpers/HtmxValsTagHelper.cs | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/Ramstack.HtmxToolkit/Serialization/HtmxLocationOptionsJsonView.cs b/src/Ramstack.HtmxToolkit/Serialization/HtmxLocationOptionsJsonView.cs index 7e7f901..9888875 100644 --- a/src/Ramstack.HtmxToolkit/Serialization/HtmxLocationOptionsJsonView.cs +++ b/src/Ramstack.HtmxToolkit/Serialization/HtmxLocationOptionsJsonView.cs @@ -3,7 +3,7 @@ namespace Ramstack.HtmxToolkit.Serialization; /// -/// Exposes location options in the JSON format expected by HTMX. +/// Represents a view of location options in the JSON format expected by HTMX. /// /// The path used for the AJAX request. /// The location options to serialize. diff --git a/src/Ramstack.HtmxToolkit/TagHelpers/HtmxConfigTagHelper.cs b/src/Ramstack.HtmxToolkit/TagHelpers/HtmxConfigTagHelper.cs index 8221bb8..86cba4a 100644 --- a/src/Ramstack.HtmxToolkit/TagHelpers/HtmxConfigTagHelper.cs +++ b/src/Ramstack.HtmxToolkit/TagHelpers/HtmxConfigTagHelper.cs @@ -9,7 +9,7 @@ namespace Ramstack.HtmxToolkit.TagHelpers; /// -/// Renders the application-wide HTMX configuration as a <meta> element. +/// Represents a tag helper that renders the application-wide HTMX configuration as a <meta> element. /// /// The service used to generate antiforgery tokens. /// The configured HtmxToolkit options. diff --git a/src/Ramstack.HtmxToolkit/TagHelpers/HtmxHeadersTagHelper.cs b/src/Ramstack.HtmxToolkit/TagHelpers/HtmxHeadersTagHelper.cs index 851929c..1f62600 100644 --- a/src/Ramstack.HtmxToolkit/TagHelpers/HtmxHeadersTagHelper.cs +++ b/src/Ramstack.HtmxToolkit/TagHelpers/HtmxHeadersTagHelper.cs @@ -12,7 +12,7 @@ namespace Ramstack.HtmxToolkit.TagHelpers; /// -/// Applies an hx-headers attribute assembled from hx-header-* attributes +/// Represents a tag helper that applies an hx-headers attribute assembled from hx-header-* attributes /// and the hx-all-headers dictionary. /// /// diff --git a/src/Ramstack.HtmxToolkit/TagHelpers/HtmxRequestTagHelper.cs b/src/Ramstack.HtmxToolkit/TagHelpers/HtmxRequestTagHelper.cs index fe40778..c4b5bf8 100644 --- a/src/Ramstack.HtmxToolkit/TagHelpers/HtmxRequestTagHelper.cs +++ b/src/Ramstack.HtmxToolkit/TagHelpers/HtmxRequestTagHelper.cs @@ -11,7 +11,7 @@ namespace Ramstack.HtmxToolkit.TagHelpers; /// -/// Renders request options as hx-request (HTMX 1.9.x and 2.x) or hx-config (HTMX 4.x). +/// Represents a tag helper that renders request options as hx-request (HTMX 1.9.x and 2.x) or hx-config (HTMX 4.x). /// /// /// HTMX 1.9.x and 2.x merge-inherit hx-request from parent elements. @@ -259,7 +259,7 @@ public override Task ProcessAsync(TagHelperContext context, TagHelperOutput outp #region Inner type: HtmxRequestData /// - /// Stores the request options before they are projected for the target HTMX version. + /// Represents the request options before they are projected for the target HTMX version. /// internal sealed class HtmxRequestData { @@ -293,7 +293,7 @@ internal sealed class HtmxRequestData #region Inner type: HtmxRequestDataPrior /// - /// Projects request configuration into the hx-request contract used by HTMX 1.9.x and 2.x. + /// Represents the projection of request configuration into the hx-request contract used by HTMX 1.9.x and 2.x. /// /// The request options to project. internal readonly struct HtmxRequestDataPrior(HtmxRequestData data) @@ -321,7 +321,7 @@ internal readonly struct HtmxRequestDataPrior(HtmxRequestData data) #region Inner type: HtmxRequestDataV4 /// - /// Projects request configuration into the hx-config contract used by HTMX 4.x. + /// Represents the projection of request configuration into the hx-config contract used by HTMX 4.x. /// /// The request options to project. internal readonly struct HtmxRequestDataV4(HtmxRequestData data) diff --git a/src/Ramstack.HtmxToolkit/TagHelpers/HtmxUrlTagHelper.cs b/src/Ramstack.HtmxToolkit/TagHelpers/HtmxUrlTagHelper.cs index 48cc51f..a6cfac8 100644 --- a/src/Ramstack.HtmxToolkit/TagHelpers/HtmxUrlTagHelper.cs +++ b/src/Ramstack.HtmxToolkit/TagHelpers/HtmxUrlTagHelper.cs @@ -16,7 +16,7 @@ namespace Ramstack.HtmxToolkit.TagHelpers; /// -/// Generates URLs for HTMX request attributes from the standard ASP.NET Core asp-* routing attributes. +/// Represents a tag helper that generates URLs for HTMX request attributes from the standard ASP.NET Core asp-* routing attributes. /// /// The factory used to create URL helpers. /// The configured HtmxToolkit options. diff --git a/src/Ramstack.HtmxToolkit/TagHelpers/HtmxValsTagHelper.cs b/src/Ramstack.HtmxToolkit/TagHelpers/HtmxValsTagHelper.cs index d396adf..3f63cdf 100644 --- a/src/Ramstack.HtmxToolkit/TagHelpers/HtmxValsTagHelper.cs +++ b/src/Ramstack.HtmxToolkit/TagHelpers/HtmxValsTagHelper.cs @@ -12,7 +12,7 @@ namespace Ramstack.HtmxToolkit.TagHelpers; /// -/// Applies an hx-vals attribute assembled from hx-val-* attributes +/// Represents a tag helper that applies an hx-vals attribute assembled from hx-val-* attributes /// and the hx-all-vals dictionary. /// ///