From 898cb0a8143cd9b6bc4501bf94b6ca55466bfe49 Mon Sep 17 00:00:00 2001
From: Bart Koelman <10324372+bkoelman@users.noreply.github.com>
Date: Tue, 21 Oct 2025 00:00:20 +0200
Subject: [PATCH] Clarify comments and move to remarks section to keep the
 namespace list clean

---
 .../IAsyncConvertEmptyActionResultFilter.cs   | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/src/JsonApiDotNetCore/Middleware/IAsyncConvertEmptyActionResultFilter.cs b/src/JsonApiDotNetCore/Middleware/IAsyncConvertEmptyActionResultFilter.cs
index 3116b45d40..5894f4b36b 100644
--- a/src/JsonApiDotNetCore/Middleware/IAsyncConvertEmptyActionResultFilter.cs
+++ b/src/JsonApiDotNetCore/Middleware/IAsyncConvertEmptyActionResultFilter.cs
@@ -5,13 +5,18 @@ namespace JsonApiDotNetCore.Middleware;
 
 /// <summary>
 /// Converts action result without parameters into action result with null parameter.
-/// <example>
-/// <code><![CDATA[
-/// return NotFound() -> return NotFound(null)
-/// ]]></code>
-/// </example>
-/// This ensures our formatter is invoked, where we'll build a JSON:API compliant response. For details, see:
-/// https://github.com/dotnet/aspnetcore/issues/16969
 /// </summary>
+/// <remarks>
+/// This basically turns calls such as
+/// <c>
+/// return NotFound()
+/// </c>
+/// into
+/// <c>
+/// return NotFound(null)
+/// </c>
+/// , so that our formatter is invoked, where we'll build a JSON:API compliant response. For details, see:
+/// https://github.com/dotnet/aspnetcore/issues/16969
+/// </remarks>
 [PublicAPI]
 public interface IAsyncConvertEmptyActionResultFilter : IAsyncAlwaysRunResultFilter;