Skip to content

Commit e7b192e

Browse files
committed
RequestContext - Fix some xml doc mistakes
1 parent 3065f20 commit e7b192e

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

CefSharp.Core/RequestContext.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ namespace CefSharp
136136
/// <param name="name">name of preference</param>
137137
/// <returns>bool if the preference exists</returns>
138138
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
139-
/// Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
139+
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
140140
/// executed on the CEF UI thread, so can be called directly.
141141
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
142142
/// application thread will be the CEF UI thread.</remarks>
@@ -157,7 +157,7 @@ namespace CefSharp
157157
/// <param name="name">preference name</param>
158158
/// <returns>Returns the value for the preference with the specified name</returns>
159159
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
160-
/// Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
160+
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
161161
/// executed on the CEF UI thread, so can be called directly.
162162
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
163163
/// application thread will be the CEF UI thread.</remarks>
@@ -196,7 +196,7 @@ namespace CefSharp
196196
/// <returns>Returns true if the preference with the specified name can be modified
197197
/// using SetPreference</returns>
198198
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
199-
/// Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
199+
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
200200
/// executed on the CEF UI thread, so can be called directly.
201201
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
202202
/// application thread will be the CEF UI thread.</remarks>
@@ -219,7 +219,7 @@ namespace CefSharp
219219
/// <param name="error">out error</param>
220220
/// <returns>Returns true if the value is set successfully and false otherwise.</returns>
221221
/// /// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
222-
/// Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
222+
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
223223
/// executed on the CEF UI thread, so can be called directly.
224224
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
225225
/// application thread will be the CEF UI thread.</remarks>

CefSharp.Core/RequestContext.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ namespace CefSharp
209209
/// <param name="name">name of preference</param>
210210
/// <returns>bool if the preference exists</returns>
211211
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
212-
/// Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
212+
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
213213
/// executed on the CEF UI thread, so can be called directly.
214214
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
215215
/// application thread will be the CEF UI thread.</remarks>
@@ -225,7 +225,7 @@ namespace CefSharp
225225
/// <param name="name">preference name</param>
226226
/// <returns>Returns the value for the preference with the specified name</returns>
227227
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
228-
/// Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
228+
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
229229
/// executed on the CEF UI thread, so can be called directly.
230230
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
231231
/// application thread will be the CEF UI thread.</remarks>
@@ -252,7 +252,7 @@ namespace CefSharp
252252
/// <returns>Returns true if the preference with the specified name can be modified
253253
/// using SetPreference</returns>
254254
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
255-
/// Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
255+
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
256256
/// executed on the CEF UI thread, so can be called directly.
257257
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
258258
/// application thread will be the CEF UI thread.</remarks>
@@ -269,8 +269,8 @@ namespace CefSharp
269269
/// <param name="value">preference value</param>
270270
/// <param name="error">out error</param>
271271
/// <returns>Returns true if the value is set successfully and false otherwise.</returns>
272-
/// /// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
273-
/// Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
272+
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
273+
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
274274
/// executed on the CEF UI thread, so can be called directly.
275275
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
276276
/// application thread will be the CEF UI thread.</remarks>

CefSharp/IRequestContext.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ public interface IRequestContext : IDisposable
9797
/// <param name="name">name of preference</param>
9898
/// <returns>bool if the preference exists</returns>
9999
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
100-
/// Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
100+
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
101101
/// executed on the CEF UI thread, so can be called directly.
102102
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
103103
/// application thread will be the CEF UI thread.</remarks>
@@ -113,7 +113,7 @@ public interface IRequestContext : IDisposable
113113
/// <param name="name">preference name</param>
114114
/// <returns>Returns the value for the preference with the specified name</returns>
115115
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
116-
/// Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
116+
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
117117
/// executed on the CEF UI thread, so can be called directly.
118118
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
119119
/// application thread will be the CEF UI thread.</remarks>
@@ -140,7 +140,7 @@ public interface IRequestContext : IDisposable
140140
/// <returns>Returns true if the preference with the specified name can be modified
141141
/// using SetPreference</returns>
142142
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
143-
/// Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
143+
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
144144
/// executed on the CEF UI thread, so can be called directly.
145145
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
146146
/// application thread will be the CEF UI thread.</remarks>
@@ -157,8 +157,8 @@ public interface IRequestContext : IDisposable
157157
/// <param name="value">preference value</param>
158158
/// <param name="error">out error</param>
159159
/// <returns>Returns true if the value is set successfully and false otherwise.</returns>
160-
/// /// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
161-
/// Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
160+
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
161+
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
162162
/// executed on the CEF UI thread, so can be called directly.
163163
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
164164
/// application thread will be the CEF UI thread.</remarks>
@@ -218,7 +218,7 @@ public interface IRequestContext : IDisposable
218218

219219
/// <summary>
220220
/// Retrieve the list of all extensions that this context has access to (see HasExtension).
221-
/// <see cref="extensionIds"/> will be populated with the list of extension ID values.
221+
/// <paramref name="extensionIds"/> will be populated with the list of extension ID values.
222222
/// This method must be called on the CEF UI thread.
223223
/// </summary>
224224
/// <param name="extensionIds">output a list of extensions Ids</param>
@@ -260,7 +260,7 @@ public interface IRequestContext : IDisposable
260260
/// - Can access chrome.* JavaScript APIs if allowed by the manifest. Visit chrome://extensions-support for the list of extension APIs currently supported by CEF.
261261
/// - Main frame navigation to non-extension content is blocked.
262262
/// - Pinch-zooming is disabled.
263-
/// - <see cref="IBrowserHost.GetExtension"/> returns the hosted extension.
263+
/// - <see cref="IBrowserHost.Extension"/> returns the hosted extension.
264264
/// - CefBrowserHost::IsBackgroundHost returns true for background hosts.
265265
///
266266
/// See https://developer.chrome.com/extensions for extension implementation and usage documentation.

0 commit comments

Comments
 (0)