Skip to content

Commit 872152e

Browse files
committed
Update IDisplayHandler documentation - add return values that were missing
1 parent 7937d4d commit 872152e

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

CefSharp/IDisplayHandler.cs

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,17 @@ public interface IDisplayHandler
4444
void OnFullscreenModeChange(IWebBrowser browserControl, IBrowser browser, bool fullscreen);
4545

4646
/// <summary>
47-
/// Called when the browser is about to display a tooltip. |text| contains the
48-
/// text that will be displayed in the tooltip. To handle the display of the
49-
/// tooltip yourself return true. Otherwise, you can optionally modify |text|
47+
/// Called when the browser is about to display a tooltip. text contains the
48+
/// text that will be displayed in the tooltip. You can optionally modify text
5049
/// and then return false to allow the browser to display the tooltip.
5150
/// When window rendering is disabled the application is responsible for
5251
/// drawing tooltips and the return value is ignored.
5352
/// </summary>
5453
/// <param name="browserControl">The ChromiumWebBrowser control</param>
5554
/// <param name="text">the text that will be displayed in the tooltip</param>
55+
/// <returns>To handle the display of the tooltip yourself return true otherwise return false
56+
/// to allow the browser to display the tooltip.</returns>
57+
/// <remarks>Option to modify tooltip is not currently implemented.</remarks>
5658
bool OnTooltipChanged(IWebBrowser browserControl, string text);
5759

5860
/// <summary>
@@ -63,11 +65,11 @@ public interface IDisplayHandler
6365
void OnStatusMessage(IWebBrowser browserControl, StatusMessageEventArgs statusMessageArgs);
6466

6567
/// <summary>
66-
/// Called to display a console message. Return true to stop the message from
67-
/// being output to the console.
68+
/// Called to display a console message.
6869
/// </summary>
6970
/// <param name="browserControl">The ChromiumWebBrowser control</param>
7071
/// <param name="consoleMessageArgs">args</param>
72+
/// <returns>Return true to stop the message from being output to the console.</returns>
7173
bool OnConsoleMessage(IWebBrowser browserControl, ConsoleMessageEventArgs consoleMessageArgs);
7274
}
7375
}

0 commit comments

Comments
 (0)