add documentation

Author: jaredcnance

Diff for: src/JsonApiDotNetCore/Builders/ContextGraphBuilder.cs

@@ -195,6 +195,10 @@ public IContextGraphBuilder AddDbContext<T>() where T : DbContext
 
         private string GetResourceNameFromDbSetProperty(PropertyInfo property, Type resourceType)
         {
+            // this check is actually duplicated in the DefaultResourceNameFormatter
+            // however, we perform it here so that we allow class attributes to be prioritized over
+            // the DbSet attribute. Eventually, the DbSet attribute should be deprecated.
+            //
             // check the class definition first
             // [Resource("models"] public class Model : Identifiable { /* ... */ }
             if (resourceType.GetCustomAttribute(typeof(ResourceAttribute)) is ResourceAttribute classResourceAttribute)

Diff for: src/JsonApiDotNetCore/Graph/IResourceNameFormatter.cs

@@ -35,6 +35,8 @@ public string FormatResourceName(Type type)
         {
             try
             {
+                // check the class definition first
+                // [Resource("models"] public class Model : Identifiable { /* ... */ }
                 if (type.GetCustomAttribute(typeof(ResourceAttribute)) is ResourceAttribute attribute)
                     return attribute.ResourceName;