Add missing API docs and fix all docs warnings

Fixes #64

Author: kzu

src/TableStorage/AttributedDocumentRepository`1.cs

@@ -5,7 +5,7 @@
 namespace Devlooped
 {
     /// <summary>
-    /// An <see cref="IDocumentRepository{T}{T}"/> implementation which relies on the entity type <typeparamref name="T"/>
+    /// An <see cref="IDocumentRepository{T}"/> implementation which relies on the entity type <typeparamref name="T"/>
     /// being annotated with <see cref="PartitionKeyAttribute"/> and <see cref="RowKeyAttribute"/>, and 
     /// optionally <see cref="TableAttribute"/> (defaults to type name).
     /// </summary>
@@ -22,6 +22,7 @@ partial class AttributedDocumentRepository<T> : DocumentRepository<T> where T :
         /// Initializes the repository using the given storage account.
         /// </summary>
         /// <param name="storageAccount">Storage account to connect to.</param>
+        /// <param name="serializer">Optional serializer to use instead of the default <see cref="DocumentSerializer.Default"/>.</param>
         public AttributedDocumentRepository(CloudStorageAccount storageAccount, IDocumentSerializer? serializer = default)
             : base(storageAccount,
                   TableRepository.GetDefaultTableName<T>(),

src/TableStorage/DocumentPartition.cs

@@ -29,6 +29,7 @@ static partial class DocumentPartition
         /// <typeparam name="T">The type of entity that the repository will manage.</typeparam>
         /// <param name="storageAccount">The storage account to use.</param>
         /// <param name="rowKey">Function to retrieve the row key for a given entity.</param>
+        /// <param name="serializer">Optional serializer to use instead of the default <see cref="DocumentSerializer.Default"/>.</param>
         /// <returns>The new <see cref="ITablePartition{T}"/>.</returns>
         public static IDocumentPartition<T> Create<T>(
             CloudStorageAccount storageAccount,
@@ -45,6 +46,7 @@ public static IDocumentPartition<T> Create<T>(
         /// <param name="storageAccount">The storage account to use.</param>
         /// <param name="tableName">Table name to use.</param>
         /// <param name="rowKey">Function to retrieve the row key for a given entity.</param>
+        /// <param name="serializer">Optional serializer to use instead of the default <see cref="DocumentSerializer.Default"/>.</param>
         /// <returns>The new <see cref="ITablePartition{T}"/>.</returns>
         public static IDocumentPartition<T> Create<T>(
             CloudStorageAccount storageAccount,
@@ -65,6 +67,7 @@ public static IDocumentPartition<T> Create<T>(
         /// If not provided, the <typeparamref name="T"/> <c>Name</c> will be used.</param>
         /// <param name="rowKey">Optional function to retrieve the row key for a given entity. 
         /// If not provided, the class will need a property annotated with <see cref="RowKeyAttribute"/>.</param>
+        /// <param name="serializer">Optional serializer to use instead of the default <see cref="DocumentSerializer.Default"/>.</param>
         /// <returns>The new <see cref="ITablePartition{T}"/>.</returns>
         public static IDocumentPartition<T> Create<T>(
             CloudStorageAccount storageAccount,

src/TableStorage/DocumentRepository.cs

@@ -23,6 +23,7 @@ static partial class DocumentRepository
         /// If not provided, the class will need a property annotated with <see cref="PartitionKeyAttribute"/>.</param>
         /// <param name="rowKey">Optional function to retrieve the row key for a given entity. 
         /// If not provided, the class will need a property annotated with <see cref="RowKeyAttribute"/>.</param>
+        /// <param name="serializer">Optional serializer to use instead of the default <see cref="DocumentSerializer.Default"/>.</param>
         /// <returns>The new <see cref="ITableRepository{T}"/>.</returns>
         public static IDocumentRepository<T> Create<T>(
             CloudStorageAccount storageAccount,

src/TableStorage/DocumentRepository`1.cs

@@ -47,6 +47,7 @@ static DocumentRepository()
         /// <param name="tableName">The table that backs this repository.</param>
         /// <param name="partitionKey">A function to determine the partition key for an entity of type <typeparamref name="T"/>.</param>
         /// <param name="rowKey">A function to determine the row key for an entity of type <typeparamref name="T"/>.</param>
+        /// <param name="serializer">Optional serializer to use instead of the default <see cref="DocumentSerializer.Default"/>.</param>
         protected internal DocumentRepository(CloudStorageAccount storageAccount, string tableName, Func<T, string> partitionKey, Func<T, string> rowKey, IDocumentSerializer serializer)
         {
             this.storageAccount = storageAccount;

src/TableStorage/IDocumentPartition`1.cs

@@ -19,8 +19,8 @@ partial interface IDocumentPartition<T> : ITableStoragePartition<T> where T : cl
         /// <example>
         /// var books = DocumentPartition.Create&lt;Book&gt;();
         /// await foreach (var book in books.EnumerateAsync(x => 
-        ///     x.PartitionKey == "Rick Riordan" && 
-        ///     x.RowKey.CompareTo("Percy Jackson") >= 0 && 
+        ///     x.PartitionKey == "Rick Riordan" &amp;&amp; 
+        ///     x.RowKey.CompareTo("Percy Jackson") >= 0 &amp;&amp; 
         ///     x.Version == "1.0"))
         /// {
         ///    Console.WriteLine(book.ISBN);

src/TableStorage/IDocumentRepository`1.cs

@@ -19,7 +19,7 @@ partial interface IDocumentRepository<T> : ITableStorage<T> where T : class
         /// </summary>
         /// <example>
         /// var books = DocumentRepository.Create&lt;Book&gt;();
-        /// await foreach (var book in books.EnumerateAsync(x => x.PartitionKey == "Rick Riordan" && x.DocumentType  ))
+        /// await foreach (var book in books.EnumerateAsync(x => x.PartitionKey == "Rick Riordan" &amp;&amp; x.DocumentType  ))
         /// {
         ///    Console.WriteLine(book.ISBN);
         /// }

src/TableStorage/ITablePartition`1.cs

@@ -28,7 +28,7 @@ partial interface ITablePartition<T> : ITableStoragePartition<T> where T : class
         /// <example>
         /// var books = TablePartition.Create&lt;Book&gt;("Bestsellers");
         /// await foreach (var published in from book in books.CreateQuery()
-        ///                                 where book.IsPublished && book.Pages > 1000
+        ///                                 where book.IsPublished &amp;&amp; book.Pages > 1000
         ///                                 select book)
         /// {
         ///    Console.WriteLine(published.ISBN);

src/TableStorage/ITableRepository`1.cs

@@ -26,7 +26,7 @@ partial interface ITableRepository<T> : ITableStorage<T> where T : class
         /// <example>
         /// var books = TableRepository.Create&lt;Book&gt;();
         /// await foreach (var published in from book in books.CreateQuery()
-        ///                                 where book.IsPublished && book.Pages > 1000
+        ///                                 where book.IsPublished &amp;&amp; book.Pages > 1000
         ///                                 select book)
         /// {
         ///    Console.WriteLine(published.ISBN);

src/TableStorage/TablePartition.cs

@@ -23,11 +23,11 @@ static partial class TablePartition
         public const string DefaultTableName = "Entities";
 
         /// <summary>
-        /// Creates an <see cref="ITablePartition{ITableEntity}"/>, using 
-        /// <see cref="DefaultTableName"/> as the table name and the 
-        /// <typeparamref name="T"/> <c>Name</c> as the partition key.
+        /// Creates an <see cref="ITablePartition{ITableEntity}"/>.
         /// </summary>
         /// <param name="storageAccount">The storage account to use.</param>
+        /// <param name="tableName">Table name to use.</param>
+        /// <param name="partitionKey">Fixed partition key to scope entity persistence.</param>
         /// <param name="updateStrategy">Strategy to apply when updating an existing entity. Defaults to <see cref="UpdateStrategy.Replace"/>.</param>
         /// <returns>The new <see cref="ITablePartition{TEntity}"/>.</returns>
         public static ITablePartition<ITableEntity> Create(CloudStorageAccount storageAccount, string tableName, string partitionKey, UpdateStrategy? updateStrategy = default)

src/TableStorage/TableStorageAttribute.cs

@@ -9,6 +9,10 @@
 
 namespace Devlooped
 {
+    /// <summary>
+    /// Base class for <see cref="PartitionKeyAttribute"/> and <see cref="RowKeyAttribute"/> 
+    /// that defines common behavior.
+    /// </summary>
     abstract partial class TableStorageAttribute : Attribute
     {
         static readonly ConcurrentDictionary<(Type EntityType, Type AttributeType), Expression> getters = new();
@@ -20,10 +24,18 @@ abstract partial class TableStorageAttribute : Attribute
             ' ', '/', '\\', '#', '?', '\t', '\n', '\r', '+', '|', '[', ']', '{', '}', '<', '>', '$', '^', '&'
         });
 
+        /// <summary>
+        /// Creates an expression for retrieving the value for the given entity and attribute type.
+        /// </summary>
+        /// <typeparam name="TEntity">The entity type.</typeparam>
+        /// <typeparam name="TAttribute">The attribute type.</typeparam>
         protected static Expression<Func<TEntity, string>> CreateGetter<TEntity, TAttribute>() where TAttribute : Attribute
             => (Expression<Func<TEntity, string>>)getters.GetOrAdd((typeof(TEntity), typeof(TAttribute)), 
                 (Func<(Type, Type), Expression<Func<TEntity, string>>>)(_ => CreateGetterCore<TEntity, TAttribute>()));
 
+        /// <summary>
+        /// Same as <see cref="CreateGetter{TEntity, TAttribute}"/> but compiled to a delegate.
+        /// </summary>
         protected static Func<TEntity, string> CreateCompiledGetter<TEntity, TAttribute>() where TAttribute : Attribute
             => (Func<TEntity, string>)compiledGetters.GetOrAdd((typeof(TEntity), typeof(TAttribute)), _ => CreateGetter<TEntity, TAttribute>().Compile());