From 585b712c4c705178b191219abb637500cfe21cef Mon Sep 17 00:00:00 2001
From: tayasui rainnya! <156585442+Tayasui-rainnya@users.noreply.github.com>
Date: Sat, 11 Apr 2026 06:27:19 +0800
Subject: [PATCH] Enhance XML comments for ShowScreenshotSelector method
Updated XML documentation for ShowScreenshotSelector method to provide clearer details on parameters and return values.
---
Ink Canvas/MainWindow_cs/MW_ImageInsert.cs | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/Ink Canvas/MainWindow_cs/MW_ImageInsert.cs b/Ink Canvas/MainWindow_cs/MW_ImageInsert.cs
index 37e74a63..37acea09 100644
--- a/Ink Canvas/MainWindow_cs/MW_ImageInsert.cs
+++ b/Ink Canvas/MainWindow_cs/MW_ImageInsert.cs
@@ -218,14 +218,17 @@ namespace Ink_Canvas
}
///
- /// 显示截图区域选择器
+ /// 显示截图区域选择器并返回用户的截图结果(区域截图或摄像头截图)。
///
- /// 截图结果,包含区域、路径和摄像头截图信息
+ /// 当用户选择包含墨迹的区域截图时,用于作为墨迹叠加的预览 ;可为 null。
+ /// 若用户确认截图则返回 ,否则返回 null。返回的结果可能为摄像头截图或区域截图,摄像头截图会包含 或 ,区域截图会包含有效的区域与路径。
///
/// 该方法会:
- /// 1. 显示截图选择器窗口
- /// 2. 获取用户选择的区域或摄像头截图
- /// 3. 返回截图结果
+ /// 1. 在 UI 线程(通过 )上显示截图选择器窗口 ;
+ /// 2. 获取用户选择的区域截图或摄像头截图;
+ /// 3. 根据用户选择构建并返回 ;
+ /// 4. 若用户取消对话框或未确认截图,返回 null;
+ /// 5. 方法内部捕获异常并记录日志(不会向调用方抛出异常),如需外部处理请调整实现以重新抛出或传回错误信息。
///
private async Task ShowScreenshotSelector(BitmapSource inkOverlayPreview = null)
{