From 2617db3f5233624de4b744b84bd7ddab7418f49e Mon Sep 17 00:00:00 2001
From: BrensNina <135912553+BrensNina@users.noreply.github.com>
Date: Tue, 30 Dec 2025 13:31:01 -0500
Subject: [PATCH] Clarify DialogHost.Close parameter documentation

The documentation for DialogHost.Close(...) described the `parameter` argument
as being "to provide to close handler", which is misleading and incomplete.

Internally, DialogHost.Close forwards the value directly to
DialogSession.Close(parameter). In DialogSession.Close, the parameter is
correctly documented as the dialog result value, which is returned by
DialogHost.Show(...) and exposed through DialogClosingEventArgs.Parameter.

This change aligns the DialogHost.Close documentation with the existing
DialogSession.Close documentation, making it clear that the parameter represents
the dialog result and is not solely intended for close handlers.
---
 src/MaterialDesignThemes.Wpf/DialogHost.cs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/MaterialDesignThemes.Wpf/DialogHost.cs b/src/MaterialDesignThemes.Wpf/DialogHost.cs
index 1fb5688e3a..4e919f2552 100644
--- a/src/MaterialDesignThemes.Wpf/DialogHost.cs
+++ b/src/MaterialDesignThemes.Wpf/DialogHost.cs
@@ -186,7 +186,7 @@ public static void Close(object? dialogIdentifier)
     ///  Close a modal dialog.
     /// </summary>
     /// <param name="dialogIdentifier"> of the instance where the dialog should be closed. Typically this will match an identifier set in XAML. </param>
-    /// <param name="parameter"> to provide to close handler</param>
+    /// <param name="parameter"> Value returned by DialogHost.ShowDialog(...) or passed to close handler if one is provided.</param>
     public static void Close(object? dialogIdentifier, object? parameter)
     {
         DialogHost dialogHost = GetInstance(dialogIdentifier);