Fixed XML comments.

kekyo · Jun 11, 2024 · 03d1fc7 · 03d1fc7
1 parent 7a5b02b
commit 03d1fc7
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 9 deletions.
diff --git a/src/Epoxy.Core/Anchor.cs b/src/Epoxy.Core/Anchor.cs
@@ -154,7 +154,7 @@ static Anchor() =>
         (Pile?)d.GetValue(PileProperty);
 
     /// <summary>
-    /// Set Pile from this Anchor.
+    /// Set Pile to this Anchor.
     /// </summary>
     public static void SetPile(DependencyObject d, Pile? pile) =>
         d.SetValue(PileProperty, pile);

diff --git a/src/Epoxy.Core/Fountain.cs b/src/Epoxy.Core/Fountain.cs
@@ -145,19 +145,19 @@ static Fountain() =>
 #endif
 
     /// <summary>
-    /// Get Pile from this Anchor.
+    /// Get Well from this Fountain.
     /// </summary>
     public static Well? GetWell(DependencyObject d) =>
         (Well?)d.GetValue(WellProperty);
 
     /// <summary>
-    /// Set Pile from this Anchor.
+    /// Set Well to this Fountain.
     /// </summary>
     public static void SetWell(DependencyObject d, Well? well) =>
         d.SetValue(WellProperty, well);
 
     /// <summary>
-    /// Clear Pile from this Anchor.
+    /// Clear Well from this Fountain.
     /// </summary>
     public static void ClearWell(DependencyObject d) =>
         d.ClearValue(WellProperty);

diff --git a/src/Epoxy.Core/Well.cs b/src/Epoxy.Core/Well.cs
@@ -130,9 +130,21 @@ private WellFactoryInstance()
 /// <example>
 /// <code>
 /// // Declared a Well into the ViewModel.
-/// this.KeyDownWell = Well.Factory.Create<Panel, KeyEventArgs>("KeyDown", async e =&gt;
+/// public Well&lt;Window&gt; WindowWell = Well.Factory.Create&lt;Window&gt;();
+/// 
+/// // ...
+/// 
+/// public MainWindowViewModel()
 /// {
-///     // Event received.
+///     this.WindowWell.Add(Window.Loaded, () =>
+///     {
+///         // Event received.
+///     });
+/// 
+///     this.WindowWell.Add&lt;KeyEventArgs&gt;("KeyDown", e =>
+///     {
+///         // Event received.
+///     });
 /// });
 /// </code>
 /// </example>

diff --git a/src/Epoxy/Well.cs b/src/Epoxy/Well.cs
@@ -73,9 +73,21 @@ namespace Epoxy;
 /// <example>
 /// <code>
 /// // Declared a Well into the ViewModel.
-/// this.ReadyWell = Well.Factory.Create<Window>("Loaded", async () =&gt;
+/// public Well&lt;Window&gt; WindowWell = Well.Factory.Create&lt;Window&gt;();
+/// 
+/// // ...
+/// 
+/// public MainWindowViewModel()
 /// {
-///     // Event received.
+///     this.WindowWell.Add(Window.Loaded, () =>
+///     {
+///         // Event received.
+///     });
+/// 
+///     this.WindowWell.Add&lt;KeyEventArgs&gt;("KeyDown", e =>
+///     {
+///         // Event received.
+///     });
 /// });
 /// </code>
 /// </example>
@@ -88,6 +100,12 @@ public static class WellExtension
     /// <typeparam name="TUIElement">Target control type</typeparam>
     /// <param name="factory">Factory instance (not used)</param>
     /// <returns>Well instance</returns>
+    /// <example>
+    /// <code>
+    /// // Declared a Well into the ViewModel.
+    /// public Well&lt;Window&gt; WindowWell = Well.Factory.Create&lt;Window&gt;();
+    /// </code>
+    /// </example>
     public static Well<TUIElement> Create<TUIElement>(
         this WellFactoryInstance factory)
         where TUIElement : UIElement =>
@@ -102,6 +120,17 @@ public static Well<TUIElement> Create<TUIElement>(
     /// <param name="well">Well</param>
     /// <param name="eventName">Event name</param>
     /// <param name="action">Action delegate</param>
+    /// <example>
+    /// <code>
+    /// public MainWindowViewModel()
+    /// {
+    ///     this.WindowWell.Add&lt;KeyEventArgs&gt;("KeyDown", e =>
+    ///     {
+    ///         // Event received.
+    ///     });
+    /// });
+    /// </code>
+    /// </example>
     public static void Add<TEventArgs>(
         this Well well,
         string eventName,
@@ -114,6 +143,17 @@ public static void Add<TEventArgs>(
     /// <param name="well">Well</param>
     /// <param name="eventName">Event name</param>
     /// <param name="action">Action delegate</param>
+    /// <example>
+    /// <code>
+    /// public MainWindowViewModel()
+    /// {
+    ///     this.WindowWell.Add("Loaded", () =>
+    ///     {
+    ///         // Event received.
+    ///     });
+    /// });
+    /// </code>
+    /// </example>
     public static void Add(
         this Well well,
         string eventName,
@@ -138,6 +178,17 @@ public static void Remove(
     /// <param name="well">Well</param>
     /// <param name="routedEvent">RoutedEvent</param>
     /// <param name="action">Action delegate</param>
+    /// <example>
+    /// <code>
+    /// public MainWindowViewModel()
+    /// {
+    ///     this.WindowWell.Add(DragDrop.DragEnter, e =>
+    ///     {
+    ///         // Event received.
+    ///     });
+    /// });
+    /// </code>
+    /// </example>
     public static void Add<TEventArgs>(
         this Well well,
 #if AVALONIA || AVALONIA11
@@ -155,6 +206,17 @@ public static void Add<TEventArgs>(
     /// <param name="well">Well</param>
     /// <param name="routedEvent">RoutedEvent</param>
     /// <param name="action">Action delegate</param>
+    /// <example>
+    /// <code>
+    /// public MainWindowViewModel()
+    /// {
+    ///     this.WindowWell.Add(Window.Loaded, () =>
+    ///     {
+    ///         // Event received.
+    ///     });
+    /// });
+    /// </code>
+    /// </example>
     public static void Add(
         this Well well,
         RoutedEvent routedEvent,

diff --git a/src/FSharp.Epoxy/Well.fs b/src/FSharp.Epoxy/Well.fs
@@ -52,8 +52,9 @@ open Avalonia.Interactivity;
 #endif
 
 /// <summary>
-/// The Well factory.
+/// The Well is used with Fountation, there will bind and can transfer .NET event signal.
 /// </summary>
+/// <remarks>See Fountain guide: https://github.com/kekyo/Epoxy#fountain</remarks>
 [<DebuggerStepThrough>]
 [<AutoOpen>]
 module public WellExtension =