Skip to content

Commit d633750

Browse files
committed
Minor API Cleanup
- Move ITaskScheduler and InternalWebBrowserExtensions into Internals folder (not for public use) - Improve some of the API xml doc
1 parent 980b9fe commit d633750

17 files changed

+63
-9
lines changed

CefSharp/Callback/ICompletionCallback.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
44

55
using System;
6+
67
namespace CefSharp
78
{
89
/// <summary>

CefSharp/CefSharp.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@
245245
<Compile Include="Internals\BrowserProcessResponse.cs" />
246246
<Compile Include="Internals\TaskExtensions.cs" />
247247
<Compile Include="IContextMenuParams.cs" />
248-
<Compile Include="ITaskScheduler.cs" />
248+
<Compile Include="Internals\ITaskScheduler.cs" />
249249
<Compile Include="JavascriptIgnoreAttribute.cs" />
250250
<Compile Include="JavascriptResponse.cs" />
251251
<Compile Include="Internals\BrowserProcessService.cs" />
@@ -268,7 +268,7 @@
268268
<Compile Include="Internals\JavascriptProperty.cs" />
269269
<Compile Include="CefCustomScheme.cs" />
270270
<Compile Include="Internals\IRenderWebBrowser.cs" />
271-
<Compile Include="InternalWebBrowserExtensions.cs" />
271+
<Compile Include="Internals\InternalWebBrowserExtensions.cs" />
272272
<Compile Include="Visitor\ICookieVisitor.cs" />
273273
<Compile Include="Visitor\INavigationEntryVisitor.cs" />
274274
<Compile Include="Visitor\IStringVisitor.cs" />

CefSharp/Event/ConsoleMessageEventArgs.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
namespace CefSharp
88
{
99
/// <summary>
10-
/// Event arguments to the ConsoleMessage event handler set up in IWebBrowser.
10+
/// Event arguments for the ConsoleMessage event handler set up in IWebBrowser.
1111
/// </summary>
1212
public class ConsoleMessageEventArgs : EventArgs
1313
{

CefSharp/Event/IsBrowserInitializedChangedEventArgs.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
namespace CefSharp
88
{
99
/// <summary>
10-
/// Event arguments to the IsBrowserInitializedChanged event handler.
10+
/// Event arguments for the IsBrowserInitializedChanged event handler.
1111
/// </summary>
1212
public class IsBrowserInitializedChangedEventArgs : EventArgs
1313
{

CefSharp/Event/JavascriptBindingEventArgs.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,20 @@
88

99
namespace CefSharp.Event
1010
{
11+
/// <summary>
12+
/// Event arguments for the <see cref="IJavascriptObjectRepository.ResolveObject"/> and
13+
/// <see cref="IJavascriptObjectRepository.ObjectBoundInJavascript"/> events
14+
/// </summary>
1115
public class JavascriptBindingEventArgs : EventArgs
1216
{
17+
/// <summary>
18+
/// The javascript object repository, used to register objects
19+
/// </summary>
1320
public IJavascriptObjectRepository ObjectRepository { get; private set; }
21+
22+
/// <summary>
23+
/// Name of the object
24+
/// </summary>
1425
public string ObjectName { get; private set; }
1526

1627
public JavascriptBindingEventArgs(IJavascriptObjectRepository objectRepository, string name)

CefSharp/Event/LoadingStateChangedEventArgs.cs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,26 @@ namespace CefSharp
1111
/// </summary>
1212
public class LoadingStateChangedEventArgs : EventArgs
1313
{
14+
/// <summary>
15+
/// Returns true if the browser can navigate forwards.
16+
/// </summary>
1417
public bool CanGoForward { get; private set; }
18+
/// <summary>
19+
/// Returns true if the browser can navigate backwards.
20+
/// </summary>
1521
public bool CanGoBack { get; private set; }
22+
/// <summary>
23+
/// Returns true if the browser can reload.
24+
/// </summary>
1625
public bool CanReload { get; private set; }
26+
/// <summary>
27+
/// Returns true if the browser is loading.
28+
/// </summary>
1729
public bool IsLoading { get; private set; }
30+
31+
/// <summary>
32+
/// Access to the underlying <see cref="IBrowser"/> object
33+
/// </summary>
1834
public IBrowser Browser { get; private set; }
1935

2036
public LoadingStateChangedEventArgs(IBrowser browser, bool canGoBack, bool canGoForward, bool isLoading)

CefSharp/ICookieManager.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ public interface ICookieManager : IDisposable
7373
/// <summary>
7474
/// Flush the backing store (if any) to disk
7575
/// </summary>
76-
/// <param name="callback">If non-NULL it willbe executed asnychronously on the CEF IO thread after the flush is complete.</param>
76+
/// <param name="callback">If non-NULL it will be executed asnychronously on the CEF IO thread after the flush is complete.</param>
7777
/// <return>Returns false if cookies cannot be accessed.</return>
7878
bool FlushStore(ICompletionCallback callback);
7979

CefSharp/IPopupFeatures.cs

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

55
namespace CefSharp
66
{
7+
/// <summary>
8+
/// Class representing popup window features.
9+
/// </summary>
710
public interface IPopupFeatures
811
{
912
int X { get; }

CefSharp/IPostData.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+
/// Class used to represent post data for a web request. The methods of this class may be called on any thread.
12+
/// </summary>
1013
public interface IPostData : IDisposable
1114
{
1215
/// <summary>

CefSharp/IPostDataElement.cs

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

77
namespace CefSharp
88
{
9+
/// <summary>
10+
/// Class used to represent a single element in the request post data.
11+
/// The methods of this class may be called on any thread.
12+
/// </summary>
913
public interface IPostDataElement : IDisposable
1014
{
1115
/// <summary>

0 commit comments

Comments
 (0)