Improve ctors documentation

devlooped · May 26, 2021 · 5319651 · 5319651
1 parent 443ac8b
commit 5319651
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/src/TableStorage/TablePartition`1.cs b/src/TableStorage/TablePartition`1.cs
@@ -17,8 +17,10 @@ partial class TablePartition<T> : ITablePartition<T> where T : class
         /// <summary>
         /// Initializes the repository with the given storage account and optional table name.
         /// </summary>
-        /// <param name="storageAccount">The storage account to use.</param>
-        /// <param name="tableName">Optional table name. If no value is provided, <see cref="DefaultTableName"/> will be used.</param>
+        /// <param name="storageAccount">The <see cref="CloudStorageAccount"/> to use to connect to the table.</param>
+        /// <param name="tableName">The table that backs this table partition.</param>
+        /// <param name="partitionKey">The fixed partition key that backs this table partition.</param>
+        /// <param name="rowKey">A function to determine the row key for an entity of type <typeparamref name="T"/> within the partition.</param>
         protected internal TablePartition(CloudStorageAccount storageAccount, string tableName, string partitionKey, Func<T, string> rowKey)
         {
             TableName = tableName ?? TablePartition.GetDefaultTableName<T>();

diff --git a/src/TableStorage/TableRepository`1.cs b/src/TableStorage/TableRepository`1.cs
@@ -28,6 +28,13 @@ partial class TableRepository<T> : ITableRepository<T> where T : class
         readonly Func<T, string> rowKey;
         readonly AsyncLazy<CloudTable> table;
 
+        /// <summary>
+        /// Initializes the table repository.
+        /// </summary>
+        /// <param name="storageAccount">The <see cref="CloudStorageAccount"/> to use to connect to the table.</param>
+        /// <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>
         protected internal TableRepository(CloudStorageAccount storageAccount, string tableName, Func<T, string> partitionKey, Func<T, string> rowKey)
         {
             this.storageAccount = storageAccount;