update documentation

Author: jaredcnance

src/JsonApiDotNetCore/Models/HasManyThroughAttribute.cs

@@ -4,25 +4,36 @@
 namespace JsonApiDotNetCore.Models
 {
     /// <summary>
-    /// 
+    /// Create a HasMany relationship through a many-to-many join relationship.
     /// </summary>
     /// 
     /// <example>
-    /// 
+    /// In the following example, we expose a relationship named "tags"
+    /// through the navigation property `ArticleTags`.
+    /// The `Tags` property is decorated as `NotMapped` so that EF does not try
+    /// to map this to a database relationship.
+    /// <code>
+    /// [NotMapped]
+    /// [HasManyThrough("tags", nameof(ArticleTags))]
+    /// public List&lt;Tag&gt; Tags { get; set; }
+    /// public List&lt;ArticleTag&gt; ArticleTags { get; set; }
+    /// </code>
     /// </example>
     public class HasManyThroughAttribute : HasManyAttribute
     {
         /// <summary>
-        /// 
+        /// Create a HasMany relationship through a many-to-many join relationship.
+        /// The public name exposed through the API will be based on the configured convention.
         /// </summary>
         /// 
-        /// <param name="publicName">The relationship name as exposed by the API</param>
         /// <param name="internalThroughName">The name of the navigation property that will be used to get the HasMany relationship</param>
         /// <param name="documentLinks">Which links are available. Defaults to <see cref="Link.All"/></param>
         /// <param name="canInclude">Whether or not this relationship can be included using the <c>?include=public-name</c> query string</param>
         /// 
         /// <example>
-        /// 
+        /// <code>
+        /// [HasManyThrough(nameof(ArticleTags), documentLinks: Link.All, canInclude: true)]
+        /// </code>
         /// </example>
         public HasManyThroughAttribute(string internalThroughName, Link documentLinks = Link.All, bool canInclude = true)
         : base(null, documentLinks, canInclude)
@@ -31,7 +42,7 @@ public HasManyThroughAttribute(string internalThroughName, Link documentLinks =
         }
 
         /// <summary>
-        /// 
+        /// Create a HasMany relationship through a many-to-many join relationship.
         /// </summary>
         /// 
         /// <param name="publicName">The relationship name as exposed by the API</param>
@@ -40,19 +51,36 @@ public HasManyThroughAttribute(string internalThroughName, Link documentLinks =
         /// <param name="canInclude">Whether or not this relationship can be included using the <c>?include=public-name</c> query string</param>
         /// 
         /// <example>
-        /// 
+        /// <code>
+        /// [HasManyThrough("tags", nameof(ArticleTags), documentLinks: Link.All, canInclude: true)]
+        /// </code>
         /// </example>
         public HasManyThroughAttribute(string publicName, string internalThroughName, Link documentLinks = Link.All, bool canInclude = true)
         : base(publicName, documentLinks, canInclude)
         {
             InternalThroughName = internalThroughName;
         }
 
+        /// <summary>
+        /// The name of the join property on the parent resource.
+        /// </summary>
+        /// <example>
+        /// In the `[HasManyThrough("tags", nameof(ArticleTags))]` example
+        /// this would be "ArticleTags".
+        /// </example>
         public string InternalThroughName { get; private set; }
+
+        /// <summary>
+        /// The join type.
+        /// </summary>
+        /// <example>
+        /// In the `[HasManyThrough("tags", nameof(ArticleTags))]` example
+        /// this would be `ArticleTag`.
+        /// </example>
         public Type ThroughType { get; internal set; }
 
         /// <summary>
-        /// The navigation property back to the parent resource.
+        /// The navigation property back to the parent resource from the join type.
         /// </summary>
         /// 
         /// <example>
@@ -67,7 +95,7 @@ public HasManyThroughAttribute(string publicName, string internalThroughName, Li
         public PropertyInfo LeftProperty { get; internal set; }
 
         /// <summary>
-        /// The navigation property to the related resource.
+        /// The navigation property to the related resource from the join type.
         /// </summary>
         /// 
         /// <example>