Fixes to doc-comments to improve layout of generated API documentation

Author: bkoelman

src/Examples/NoEntityFrameworkExample/NullSafeExpressionRewriter.cs

@@ -6,14 +6,13 @@ namespace NoEntityFrameworkExample;
 /// <summary>
 /// Inserts a null check on member dereference and extension method invocation, to prevent a <see cref="NullReferenceException" /> from being thrown when
 /// the expression is compiled and executed.
-/// </summary>
-/// For example,
-/// <code><![CDATA[
+/// <example>
+/// For example, <code><![CDATA[
 /// Database.TodoItems.Where(todoItem => todoItem.Assignee.Id == todoItem.Owner.Id)
-/// ]]> </code>
-/// would throw if the database contains a
-/// TodoItem that doesn't have an assignee.
-/// <example></example>
+/// ]]></code> would throw if the database
+/// contains a TodoItem that doesn't have an assignee.
+/// </example>
+/// </summary>
 public sealed class NullSafeExpressionRewriter : ExpressionVisitor
 {
     private const string MinValueName = nameof(long.MinValue);

src/JsonApiDotNetCore.Annotations/Resources/Annotations/EagerLoadAttribute.cs

@@ -8,8 +8,9 @@ namespace JsonApiDotNetCore.Resources.Annotations;
 /// </summary>
 /// <remarks>
 /// This is intended for calculated properties that are exposed as JSON:API attributes, which depend on a related entity to always be loaded.
-/// <example><![CDATA[
-/// public class User : Identifiable
+/// <example>
+/// <code><![CDATA[
+/// public class User : Identifiable<long>
 /// {
 ///     [Attr(AttrCapabilities.AllowFilter | AttrCapabilities.AllowSort)]
 ///     [NotMapped]
@@ -25,12 +26,13 @@ namespace JsonApiDotNetCore.Resources.Annotations;
 ///     public string Last { get; set; }
 /// }
 /// 
-/// public class Blog : Identifiable
+/// public class Blog : Identifiable<long>
 /// {
 ///     [HasOne]
 ///     public User Author { get; set; }
 /// }
-/// ]]></example>
+/// ]]></code>
+/// </example>
 /// </remarks>
 [PublicAPI]
 [AttributeUsage(AttributeTargets.Property)]

src/JsonApiDotNetCore.Annotations/Resources/Annotations/HasManyAttribute.cs

@@ -11,7 +11,7 @@ namespace JsonApiDotNetCore.Resources.Annotations;
 /// </summary>
 /// <example>
 /// <code><![CDATA[
-/// public class Author : Identifiable
+/// public class Author : Identifiable<long>
 /// {
 ///     [HasMany]
 ///     public ISet<Article> Articles { get; set; }

src/JsonApiDotNetCore.Annotations/Resources/Annotations/HasOneAttribute.cs

@@ -9,7 +9,7 @@ namespace JsonApiDotNetCore.Resources.Annotations;
 /// </summary>
 /// <example>
 /// <code><![CDATA[
-/// public class Article : Identifiable
+/// public class Article : Identifiable<long>
 /// {
 ///     [HasOne]
 ///     public Author Author { get; set; }

src/JsonApiDotNetCore.Annotations/Resources/Annotations/RelationshipAttribute.cs

@@ -25,13 +25,13 @@ public abstract class RelationshipAttribute : ResourceFieldAttribute
     /// </summary>
     /// <example>
     /// <code><![CDATA[
-    /// public class Article : Identifiable
+    /// public class Article : Identifiable<long>
     /// {
     ///     [HasOne] // InverseNavigationProperty: Person.Articles
     ///     public Person Owner { get; set; }
     /// }
     /// 
-    /// public class Person : Identifiable
+    /// public class Person : Identifiable<long>
     /// {
     ///     [HasMany] // InverseNavigationProperty: Article.Owner
     ///     public ICollection<Article> Articles { get; set; }

src/JsonApiDotNetCore.Annotations/Resources/RuntimeTypeConverter.cs

@@ -167,12 +167,12 @@ public static bool CanContainNull(Type type)
 
     /// <summary>
     /// Gets the name of a type, including the names of its generic type arguments, without any namespaces.
-    /// <example>
-    /// <code><![CDATA[
+    /// </summary>
+    /// <returns>
+    /// Example return value: <code><![CDATA[
     /// KeyValuePair<TimeSpan, Nullable<DateTimeOffset>>
     /// ]]></code>
-    /// </example>
-    /// </summary>
+    /// </returns>
     public static string GetFriendlyTypeName(Type type)
     {
         ArgumentNullException.ThrowIfNull(type);

src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs

@@ -191,7 +191,7 @@ public interface IJsonApiOptions
     /// Enables to customize the settings that are used by the <see cref="JsonSerializer" />.
     /// </summary>
     /// <example>
-    /// The next example sets the naming convention to camel casing.
+    /// The following example sets the naming convention to camel casing.
     /// <code><![CDATA[
     /// options.SerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
     /// options.SerializerOptions.DictionaryKeyPolicy = JsonNamingPolicy.CamelCase;

src/JsonApiDotNetCore/Controllers/Annotations/DisableQueryStringAttribute.cs

@@ -6,14 +6,16 @@ namespace JsonApiDotNetCore.Controllers.Annotations;
 /// <summary>
 /// Used on an ASP.NET controller class to indicate which query string parameters are blocked.
 /// </summary>
-/// <example><![CDATA[
+/// <example>
+/// <code><![CDATA[
 /// [DisableQueryString(JsonApiQueryStringParameters.Sort | JsonApiQueryStringParameters.Page)]
 /// public class CustomersController : JsonApiController<Customer> { }
-/// ]]></example>
-/// <example><![CDATA[
+/// ]]></code>
+/// <code><![CDATA[
 /// [DisableQueryString("skipCache")]
 /// public class CustomersController : JsonApiController<Customer> { }
-/// ]]></example>
+/// ]]></code>
+/// </example>
 [PublicAPI]
 [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct)]
 public sealed class DisableQueryStringAttribute : Attribute

src/JsonApiDotNetCore/Controllers/Annotations/DisableRoutingConventionAttribute.cs

@@ -5,10 +5,12 @@ namespace JsonApiDotNetCore.Controllers.Annotations;
 /// <summary>
 /// Used on an ASP.NET controller class to indicate that a custom route is used instead of the built-in routing convention.
 /// </summary>
-/// <example><![CDATA[
+/// <example>
+/// <code><![CDATA[
 /// [DisableRoutingConvention, Route("some/custom/route/to/customers")]
 /// public class CustomersController : JsonApiController<Customer> { }
-/// ]]></example>
+/// ]]></code>
+/// </example>
 [PublicAPI]
 [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct)]
 public sealed class DisableRoutingConventionAttribute : Attribute;

src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs

@@ -86,9 +86,12 @@ protected BaseJsonApiController(IJsonApiOptions options, IResourceGraph resource
     }
 
     /// <summary>
-    /// Gets a collection of primary resources. Example: <code><![CDATA[
+    /// Gets a collection of primary resources.
+    /// <para>
+    /// Example endpoint: <code language="http"><![CDATA[
     /// GET /articles HTTP/1.1
     /// ]]></code>
+    /// </para>
     /// </summary>
     public virtual async Task<IActionResult> GetAsync(CancellationToken cancellationToken)
     {
@@ -105,9 +108,12 @@ public virtual async Task<IActionResult> GetAsync(CancellationToken cancellation
     }
 
     /// <summary>
-    /// Gets a single primary resource by ID. Example: <code><![CDATA[
+    /// Gets a single primary resource by ID.
+    /// <para>
+    /// Example endpoint: <code language="http"><![CDATA[
     /// GET /articles/1 HTTP/1.1
     /// ]]></code>
+    /// </para>
     /// </summary>
     public virtual async Task<IActionResult> GetAsync([DisallowNull] TId id, CancellationToken cancellationToken)
     {
@@ -127,12 +133,15 @@ public virtual async Task<IActionResult> GetAsync([DisallowNull] TId id, Cancell
     }
 
     /// <summary>
-    /// Gets a secondary resource or collection of secondary resources. Example: <code><![CDATA[
+    /// Gets a secondary resource or collection of secondary resources.
+    /// <para>
+    /// Example endpoints: <code language="http"><![CDATA[
     /// GET /articles/1/author HTTP/1.1
-    /// ]]></code> Example:
-    /// <code><![CDATA[
+    /// ]]></code>
+    /// <code language="http"><![CDATA[
     /// GET /articles/1/revisions HTTP/1.1
     /// ]]></code>
+    /// </para>
     /// </summary>
     public virtual async Task<IActionResult> GetSecondaryAsync([DisallowNull] TId id, [PreserveEmptyString] string relationshipName,
         CancellationToken cancellationToken)
@@ -156,13 +165,15 @@ public virtual async Task<IActionResult> GetSecondaryAsync([DisallowNull] TId id
     }
 
     /// <summary>
-    /// Gets a relationship value, which can be a <c>null</c>, a single object or a collection. Example:
-    /// <code><![CDATA[
+    /// Gets a relationship value, which can be a <c>null</c>, a single object or a collection.
+    /// <para>
+    /// Example endpoints: <code language="http"><![CDATA[
     /// GET /articles/1/relationships/author HTTP/1.1
-    /// ]]></code> Example:
-    /// <code><![CDATA[
+    /// ]]></code>
+    /// <code language="http"><![CDATA[
     /// GET /articles/1/relationships/revisions HTTP/1.1
     /// ]]></code>
+    /// </para>
     /// </summary>
     public virtual async Task<IActionResult> GetRelationshipAsync([DisallowNull] TId id, [PreserveEmptyString] string relationshipName,
         CancellationToken cancellationToken)
@@ -186,9 +197,12 @@ public virtual async Task<IActionResult> GetRelationshipAsync([DisallowNull] TId
     }
 
     /// <summary>
-    /// Creates a new resource with attributes, relationships or both. Example: <code><![CDATA[
+    /// Creates a new resource with attributes, relationships or both.
+    /// <para>
+    /// Example endpoint: <code language="http"><![CDATA[
     /// POST /articles HTTP/1.1
     /// ]]></code>
+    /// </para>
     /// </summary>
     public virtual async Task<IActionResult> PostAsync([FromBody] TResource resource, CancellationToken cancellationToken)
     {
@@ -233,9 +247,12 @@ private string GetLocationUrl(string resourceId)
     }
 
     /// <summary>
-    /// Adds resources to a to-many relationship. Example: <code><![CDATA[
+    /// Adds resources to a to-many relationship.
+    /// <para>
+    /// Example endpoint: <code language="http"><![CDATA[
     /// POST /articles/1/revisions HTTP/1.1
     /// ]]></code>
+    /// </para>
     /// </summary>
     /// <param name="id">
     /// Identifies the left side of the relationship.
@@ -274,9 +291,12 @@ public virtual async Task<IActionResult> PostRelationshipAsync([DisallowNull] TI
 
     /// <summary>
     /// Updates the attributes and/or relationships of an existing resource. Only the values of sent attributes are replaced. And only the values of sent
-    /// relationships are replaced. Example: <code><![CDATA[
+    /// relationships are replaced.
+    /// <para>
+    /// Example endpoint: <code language="http"><![CDATA[
     /// PATCH /articles/1 HTTP/1.1
     /// ]]></code>
+    /// </para>
     /// </summary>
     public virtual async Task<IActionResult> PatchAsync([DisallowNull] TId id, [FromBody] TResource resource, CancellationToken cancellationToken)
     {
@@ -304,13 +324,15 @@ public virtual async Task<IActionResult> PatchAsync([DisallowNull] TId id, [From
     }
 
     /// <summary>
-    /// Performs a complete replacement of a relationship on an existing resource. Example:
-    /// <code><![CDATA[
+    /// Performs a complete replacement of a relationship on an existing resource.
+    /// <para>
+    /// Example endpoints: <code language="http"><![CDATA[
     /// PATCH /articles/1/relationships/author HTTP/1.1
-    /// ]]></code> Example:
-    /// <code><![CDATA[
+    /// ]]></code>
+    /// <code language="http"><![CDATA[
     /// PATCH /articles/1/relationships/revisions HTTP/1.1
     /// ]]></code>
+    /// </para>
     /// </summary>
     /// <param name="id">
     /// Identifies the left side of the relationship.
@@ -347,9 +369,12 @@ public virtual async Task<IActionResult> PatchRelationshipAsync([DisallowNull] T
     }
 
     /// <summary>
-    /// Deletes an existing resource. Example: <code><![CDATA[
+    /// Deletes an existing resource.
+    /// <para>
+    /// Example endpoint: <code language="http"><![CDATA[
     /// DELETE /articles/1 HTTP/1.1
     /// ]]></code>
+    /// </para>
     /// </summary>
     public virtual async Task<IActionResult> DeleteAsync([DisallowNull] TId id, CancellationToken cancellationToken)
     {
@@ -369,9 +394,12 @@ public virtual async Task<IActionResult> DeleteAsync([DisallowNull] TId id, Canc
     }
 
     /// <summary>
-    /// Removes resources from a to-many relationship. Example: <code><![CDATA[
+    /// Removes resources from a to-many relationship.
+    /// <para>
+    /// Example endpoint: <code language="http"><![CDATA[
     /// DELETE /articles/1/relationships/revisions HTTP/1.1
     /// ]]></code>
+    /// </para>
     /// </summary>
     /// <param name="id">
     /// Identifies the left side of the relationship.