WinForms - Improve xml doc

amaitland · amaitland · commit 604e9570f714 · 2022-01-05T13:20:33.000+10:00
diff --git a/CefSharp.WinForms/Handler/LifeSpanHandler.cs b/CefSharp.WinForms/Handler/LifeSpanHandler.cs
@@ -234,6 +234,9 @@ public LifeSpanHandler OnPopupDestroyed(OnPopupDestroyedDelegate onPopupDestroye
         /// Create a new instance of the <see cref="LifeSpanHandlerBuilder"/>
         /// which can be used to create a WinForms specific <see cref="ILifeSpanHandler"/>
         /// implementation that simplifies the process of hosting a Popup as a Control/Tab.
+        /// In scnarios where you also need to implement <see cref="ILoadHandler"/> then instead
+        /// of implementing directly you will need to inherit from <see cref="CefSharp.WinForms.Handler.LoadHandler"/>.
+        /// As it provides base functionality required to make <see cref="ChromiumHostControl"/> events work correctly.
         /// </summary>
         /// <returns>LifeSpanHandlerBuilder</returns>
         public static LifeSpanHandlerBuilder Create()
diff --git a/CefSharp.WinForms/Handler/LifeSpanHandlerBuilder.cs b/CefSharp.WinForms/Handler/LifeSpanHandlerBuilder.cs
@@ -5,7 +5,7 @@
 namespace CefSharp.WinForms.Handler
 {
     /// <summary>
-    /// Fluent LifeSpanHandler Builder
+    /// Fluent <see cref="CefSharp.WinForms.Handler.LifeSpanHandler"/> Builder
     /// </summary>
     public class LifeSpanHandlerBuilder
     {
@@ -61,7 +61,7 @@ public LifeSpanHandlerBuilder OnPopupDestroyed(OnPopupDestroyedDelegate onPopupD
         /// <see cref="ILifeSpanHandler"/> returns true in <see cref="ILifeSpanHandler.DoClose(IWebBrowser, IBrowser)"/>
         /// so no WM_CLOSE message is sent, this differs from the default CEF behaviour.
         /// </summary>
-        /// <returns>a <see cref="IDownloadHandler"/> instance</returns>
+        /// <returns>a <see cref="ILifeSpanHandler"/> instance</returns>
         public ILifeSpanHandler Build()
         {
             return handler;

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`namespace CefSharp.WinForms.Handler`
`6`	`6`	`{`
`7`	`7`	`/// <summary>`
`8`		`- /// Fluent LifeSpanHandler Builder`
	`8`	`+ /// Fluent <see cref="CefSharp.WinForms.Handler.LifeSpanHandler"/> Builder`
`9`	`9`	`/// </summary>`
`10`	`10`	`public class LifeSpanHandlerBuilder`
`11`	`11`	`{`
`@@ -61,7 +61,7 @@ public LifeSpanHandlerBuilder OnPopupDestroyed(OnPopupDestroyedDelegate onPopupD`
`61`	`61`	`/// <see cref="ILifeSpanHandler"/> returns true in <see cref="ILifeSpanHandler.DoClose(IWebBrowser, IBrowser)"/>`
`62`	`62`	`/// so no WM_CLOSE message is sent, this differs from the default CEF behaviour.`
`63`	`63`	`/// </summary>`
`64`		`- /// <returns>a <see cref="IDownloadHandler"/> instance</returns>`
	`64`	`+ /// <returns>a <see cref="ILifeSpanHandler"/> instance</returns>`
`65`	`65`	`public ILifeSpanHandler Build()`
`66`	`66`	`{`
`67`	`67`	`return handler;`