Skip to content

Commit f04648e

Browse files
committed
Xml Doc - Add some more xml doc
Some of it's just placeholder doc to keep sandcastle happy
1 parent 1c81f95 commit f04648e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+422
-82
lines changed

CefSharp.Core/AbstractCefSettings.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ namespace CefSharp
2828
/// <summary>
2929
/// Default Constructor
3030
/// </summary>
31-
AbstractCefSettings() : _cefSettings(new ::CefSettings())
31+
AbstractCefSettings() : _cefSettings(new ::CefSettings())
3232
{
3333
_cefSettings->multi_threaded_message_loop = true;
3434
_cefSettings->no_sandbox = true;

CefSharp.OffScreen/CefSettings.cs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,15 @@
44

55
namespace CefSharp.OffScreen
66
{
7+
/// <summary>
8+
/// Initialization settings. Many of these and other settings can also configured
9+
/// using command-line switches.
10+
/// </summary>
711
public class CefSettings : AbstractCefSettings
812
{
9-
//TODO: This is duplicated with the WPF version
13+
/// <summary>
14+
/// Intialize with default values
15+
/// </summary>
1016
public CefSettings() : base()
1117
{
1218
WindowlessRenderingEnabled = true;

CefSharp.WinForms/CefSettings.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
namespace CefSharp.WinForms
66
{
7+
/// <summary>
8+
/// Initialization settings. Many of these and other settings can also configured
9+
/// using command-line switches.
10+
/// </summary>
711
public class CefSettings : AbstractCefSettings
812
{
913
}

CefSharp.Wpf/CefSettings.cs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,15 @@
44

55
namespace CefSharp.Wpf
66
{
7+
/// <summary>
8+
/// Initialization settings. Many of these and other settings can also configured
9+
/// using command-line switches.
10+
/// </summary>
711
public class CefSettings : AbstractCefSettings
812
{
9-
//TODO: This is duplicated with the Offscreen version
13+
/// <summary>
14+
/// Intialize with default values
15+
/// </summary>
1016
public CefSettings() : base()
1117
{
1218
WindowlessRenderingEnabled = true;

CefSharp/BindingOptions.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ public static BindingOptions DefaultBinder
3636
/// </summary>
3737
public IMethodInterceptor MethodInterceptor { get; set; }
3838

39+
/// <summary>
40+
/// Default constructor
41+
/// </summary>
3942
public BindingOptions()
4043
{
4144
CamelCaseJavascriptNames = true;

CefSharp/Callback/IJavascriptCallback.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,21 @@
77

88
namespace CefSharp
99
{
10+
/// <summary>
11+
/// Javascript callback interface
12+
/// </summary>
1013
public interface IJavascriptCallback : IDisposable
1114
{
1215
/// <summary>
1316
/// Callback Id
1417
/// </summary>
1518
Int64 Id { get; }
1619

20+
/// <summary>
21+
/// Execute the javascript callback
22+
/// </summary>
23+
/// <param name="parms">param array of objects</param>
24+
/// <returns>JavascriptResponse</returns>
1725
Task<JavascriptResponse> ExecuteAsync(params object[] parms);
1826

1927
/// <summary>

CefSharp/Callback/IJsDialogCallback.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66

77
namespace CefSharp
88
{
9+
/// <summary>
10+
/// Callback interface used for asynchronous continuation of JavaScript dialog requests.
11+
/// </summary>
912
public interface IJsDialogCallback : IDisposable
1013
{
1114
/// <summary>

CefSharp/Callback/IRequestCallback.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66

77
namespace CefSharp
88
{
9+
/// <summary>
10+
/// Callback interface used for asynchronous continuation of url requests.
11+
/// </summary>
912
public interface IRequestCallback : IDisposable
1013
{
1114
/// <summary>

CefSharp/Callback/IResolveCallback.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77

88
namespace CefSharp
99
{
10+
/// <summary>
11+
/// Callback interface for <see cref="IRequestContext.ResolveHostAsync(Uri)"/>
12+
/// </summary>
1013
public interface IResolveCallback : IDisposable
1114
{
1215
/// <summary>

CefSharp/Callback/IRunContextMenuCallback.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66

77
namespace CefSharp
88
{
9+
/// <summary>
10+
/// Callback interface used for continuation of custom context menu display.
11+
/// </summary>
912
public interface IRunContextMenuCallback : IDisposable
1013
{
1114
/// <summary>

0 commit comments

Comments
 (0)