From decfa4fa121e57c6df9230776388a782e7ea748c Mon Sep 17 00:00:00 2001
From: MSuMshk <2039814060@qq.com>
Date: Tue, 3 Mar 2026 08:38:42 +0800
Subject: [PATCH] fix: resolve ProductBatchToolController xml doc warnings

---
 .../Controllers/ProductBatchToolController.cs | 54 +++++++++++++++++++
 1 file changed, 54 insertions(+)

diff --git a/src/Api/TakeoutSaaS.TenantApi/Controllers/ProductBatchToolController.cs b/src/Api/TakeoutSaaS.TenantApi/Controllers/ProductBatchToolController.cs
index 1f3c95f..082144d 100644
--- a/src/Api/TakeoutSaaS.TenantApi/Controllers/ProductBatchToolController.cs
+++ b/src/Api/TakeoutSaaS.TenantApi/Controllers/ProductBatchToolController.cs
@@ -16,6 +16,12 @@ using TakeoutSaaS.TenantApi.Contracts.Product;
 
 namespace TakeoutSaaS.TenantApi.Controllers;
 
+/// <summary>
+/// 提供商品批量工具能力，包括批量调价、上下架、移类、跨店同步、导入与导出。
+/// </summary>
+/// <param name="dbContext">应用数据库上下文。</param>
+/// <param name="storeContextService">门店上下文服务。</param>
+/// <param name="idGenerator">雪花 ID 生成器。</param>
 [ApiVersion("1.0")]
 [Authorize]
 [Route("api/tenant/v{version:apiVersion}/product/batch")]
@@ -39,6 +45,12 @@ public sealed class ProductBatchToolController(
         "状态"
     ];
 
+    /// <summary>
+    /// 预览批量调价结果。
+    /// </summary>
+    /// <param name="request">调价预览请求。</param>
+    /// <param name="cancellationToken">取消令牌。</param>
+    /// <returns>调价预览结果。</returns>
     [HttpPost("price-adjust/preview")]
     [ProducesResponseType(typeof(ApiResponse<BatchPricePreviewResponse>), StatusCodes.Status200OK)]
     public async Task<ApiResponse<BatchPricePreviewResponse>> PreviewPriceAdjust(
@@ -81,6 +93,12 @@ public sealed class ProductBatchToolController(
         });
     }
 
+    /// <summary>
+    /// 执行批量调价。
+    /// </summary>
+    /// <param name="request">调价请求。</param>
+    /// <param name="cancellationToken">取消令牌。</param>
+    /// <returns>批量工具执行结果。</returns>
     [HttpPost("price-adjust")]
     [ProducesResponseType(typeof(ApiResponse<BatchToolResultResponse>), StatusCodes.Status200OK)]
     public async Task<ApiResponse<BatchToolResultResponse>> PriceAdjust(
@@ -123,6 +141,12 @@ public sealed class ProductBatchToolController(
         });
     }
 
+    /// <summary>
+    /// 批量切换商品上下架状态。
+    /// </summary>
+    /// <param name="request">上下架切换请求。</param>
+    /// <param name="cancellationToken">取消令牌。</param>
+    /// <returns>批量工具执行结果。</returns>
     [HttpPost("sale-switch")]
     [ProducesResponseType(typeof(ApiResponse<BatchToolResultResponse>), StatusCodes.Status200OK)]
     public async Task<ApiResponse<BatchToolResultResponse>> SaleSwitch(
@@ -186,6 +210,12 @@ public sealed class ProductBatchToolController(
         });
     }
 
+    /// <summary>
+    /// 批量移动商品分类。
+    /// </summary>
+    /// <param name="request">移类请求。</param>
+    /// <param name="cancellationToken">取消令牌。</param>
+    /// <returns>批量工具执行结果。</returns>
     [HttpPost("move-category")]
     [ProducesResponseType(typeof(ApiResponse<BatchToolResultResponse>), StatusCodes.Status200OK)]
     public async Task<ApiResponse<BatchToolResultResponse>> MoveCategory(
@@ -256,6 +286,12 @@ public sealed class ProductBatchToolController(
         });
     }
 
+    /// <summary>
+    /// 将源门店商品批量同步到目标门店。
+    /// </summary>
+    /// <param name="request">跨店同步请求。</param>
+    /// <param name="cancellationToken">取消令牌。</param>
+    /// <returns>批量工具执行结果。</returns>
     [HttpPost("store-sync")]
     [ProducesResponseType(typeof(ApiResponse<BatchToolResultResponse>), StatusCodes.Status200OK)]
     public async Task<ApiResponse<BatchToolResultResponse>> SyncStore(
@@ -479,6 +515,12 @@ public sealed class ProductBatchToolController(
         });
     }
 
+    /// <summary>
+    /// 下载商品批量导入模板。
+    /// </summary>
+    /// <param name="storeId">门店 ID。</param>
+    /// <param name="cancellationToken">取消令牌。</param>
+    /// <returns>导入模板文件。</returns>
     [HttpGet("import/template")]
     [ProducesResponseType(typeof(ApiResponse<BatchExcelFileResponse>), StatusCodes.Status200OK)]
     public async Task<ApiResponse<BatchExcelFileResponse>> DownloadImportTemplate(
@@ -519,6 +561,12 @@ public sealed class ProductBatchToolController(
         });
     }
 
+    /// <summary>
+    /// 批量导入商品。
+    /// </summary>
+    /// <param name="request">导入请求。</param>
+    /// <param name="cancellationToken">取消令牌。</param>
+    /// <returns>导入结果。</returns>
     [HttpPost("import")]
     [Consumes("multipart/form-data")]
     [ProducesResponseType(typeof(ApiResponse<BatchImportResultResponse>), StatusCodes.Status200OK)]
@@ -858,6 +906,12 @@ public sealed class ProductBatchToolController(
         });
     }
 
+    /// <summary>
+    /// 按范围导出商品 Excel。
+    /// </summary>
+    /// <param name="request">导出请求。</param>
+    /// <param name="cancellationToken">取消令牌。</param>
+    /// <returns>导出文件。</returns>
     [HttpPost("export")]
     [ProducesResponseType(typeof(ApiResponse<BatchExcelFileResponse>), StatusCodes.Status200OK)]
     public async Task<ApiResponse<BatchExcelFileResponse>> Export(