Skip to content

Commit 0d23112

Browse files
committed
Core - Xml Doc Fixes
1 parent 9beeefc commit 0d23112

File tree

3 files changed

+17
-17
lines changed

3 files changed

+17
-17
lines changed

CefSharp.BrowserSubprocess.Core/WcfBrowserSubprocessExecutable.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ namespace CefSharp
2121
/// WcfBrowserSubprocessExecutable provides the fundimental browser process handling for
2222
/// CefSharp.BrowserSubprocess.exe and can be used to self host the BrowserSubProcess in your
2323
/// existing application (preferred approach for .Net Core).
24-
/// If the <see cref="CefSharpArguments.WcfEnabledArgument"/> command line argument is
24+
/// If the <see cref="CefSharpArguments::WcfEnabledArgument"/> command line argument is
2525
/// present then the WcfEnabledSubProcess implementation is used.
2626
/// </summary>
2727
public ref class WcfBrowserSubprocessExecutable : BrowserSubprocessExecutable

CefSharp.Core/Cef.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -558,7 +558,7 @@ namespace CefSharp
558558
/// Async returns a list containing Plugin Information
559559
/// (Wrapper around CefVisitWebPluginInfo)
560560
/// </summary>
561-
/// <returns>Returns List of <see cref="Plugin"/> structs.</returns>
561+
/// <returns>Returns List of <see cref="WebPluginInfo"/> structs.</returns>
562562
static Task<List<WebPluginInfo^>^>^ GetPlugins()
563563
{
564564
auto taskVisitor = gcnew TaskWebPluginInfoVisitor();
@@ -769,7 +769,7 @@ namespace CefSharp
769769
/// will receive an ErrorCode value of <see cref="CdmRegistrationErrorCode::NotSupported"/>.
770770
/// </summary>
771771
/// <param name="path"> is a directory that contains the Widevine CDM files</param>
772-
/// <param name="callback">optional callback - <see cref="IRegisterCdmCallback::OnRegistrationCompletecallback"/>
772+
/// <param name="callback">optional callback - <see cref="IRegisterCdmCallback::OnRegistrationComplete"/>
773773
/// will be executed asynchronously once registration is complete</param>
774774
static void RegisterWidevineCdm(String^ path, [Optional] IRegisterCdmCallback^ callback)
775775
{

CefSharp.Core/RequestContext.h

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ namespace CefSharp
211211
/// <param name="name">name of preference</param>
212212
/// <returns>bool if the preference exists</returns>
213213
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
214-
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
214+
/// <see cref="IBrowserProcessHandler::OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
215215
/// executed on the CEF UI thread, so can be called directly.
216216
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
217217
/// application thread will be the CEF UI thread.</remarks>
@@ -227,7 +227,7 @@ namespace CefSharp
227227
/// <param name="name">preference name</param>
228228
/// <returns>Returns the value for the preference with the specified name</returns>
229229
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
230-
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
230+
/// <see cref="IBrowserProcessHandler::OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
231231
/// executed on the CEF UI thread, so can be called directly.
232232
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
233233
/// application thread will be the CEF UI thread.</remarks>
@@ -272,16 +272,16 @@ namespace CefSharp
272272
/// <param name="error">out error</param>
273273
/// <returns>Returns true if the value is set successfully and false otherwise.</returns>
274274
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
275-
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
275+
/// <see cref="IBrowserProcessHandler::OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
276276
/// executed on the CEF UI thread, so can be called directly.
277277
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
278278
/// application thread will be the CEF UI thread.</remarks>
279279
virtual bool SetPreference(String^ name, Object^ value, [Out] String^ %error);
280280

281281
/// <summary>
282282
/// Clears all certificate exceptions that were added as part of handling
283-
/// <see cref="IRequestHandler.OnCertificateError"/>. If you call this it is
284-
/// recommended that you also call <see cref="IRequestContext.CloseAllConnections"/> or you risk not
283+
/// <see cref="IRequestHandler::OnCertificateError"/>. If you call this it is
284+
/// recommended that you also call <see cref="IRequestContext::CloseAllConnections"/> or you risk not
285285
/// being prompted again for server certificates if you reconnect quickly.
286286
/// </summary>
287287
/// <param name="callback">If is non-NULL it will be executed on the CEF UI thread after
@@ -290,7 +290,7 @@ namespace CefSharp
290290

291291
/// <summary>
292292
/// Clears all HTTP authentication credentials that were added as part of handling
293-
/// <see cref="IRequestHandler.GetAuthCredentials"/>.
293+
/// <see cref="IRequestHandler::GetAuthCredentials"/>.
294294
/// </summary>
295295
/// <param name="callback">If is non-NULL it will be executed on the CEF UI thread after
296296
/// completion. This param is optional</param>
@@ -318,7 +318,7 @@ namespace CefSharp
318318
/// </summary>
319319
/// <returns>Returns true if this context was used to load the extension identified by extensionId</returns>
320320
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
321-
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
321+
/// <see cref="IBrowserProcessHandler::OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
322322
/// executed on the CEF UI thread, so can be called directly.
323323
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
324324
/// application thread will be the CEF UI thread.</remarks>
@@ -331,7 +331,7 @@ namespace CefSharp
331331
/// <param name="extensionId">extension Id</param>
332332
/// <returns>Returns the extension matching extensionId or null if no matching extension is accessible in this context</returns>
333333
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
334-
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
334+
/// <see cref="IBrowserProcessHandler::OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
335335
/// executed on the CEF UI thread, so can be called directly.
336336
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
337337
/// application thread will be the CEF UI thread.</remarks>
@@ -345,7 +345,7 @@ namespace CefSharp
345345
/// <param name="extensionIds">output a list of extensions Ids</param>
346346
/// <returns>returns true on success otherwise false</returns>
347347
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
348-
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
348+
/// <see cref="IBrowserProcessHandler::OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
349349
/// executed on the CEF UI thread, so can be called directly.
350350
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
351351
/// application thread will be the CEF UI thread.</remarks>
@@ -359,7 +359,7 @@ namespace CefSharp
359359
/// <param name="extensionId">extension id</param>
360360
/// <returns>Returns true if this context has access to the extension identified by extensionId</returns>
361361
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
362-
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
362+
/// <see cref="IBrowserProcessHandler::OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
363363
/// executed on the CEF UI thread, so can be called directly.
364364
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
365365
/// application thread will be the CEF UI thread.</remarks>
@@ -373,9 +373,9 @@ namespace CefSharp
373373
/// and manifestJson should contain the contents that would otherwise be read from the "manifest.json" file on disk.
374374
/// The loaded extension will be accessible in all contexts sharing the same storage (HasExtension returns true).
375375
/// However, only the context on which this method was called is considered the loader (DidLoadExtension returns true) and only the
376-
/// loader will receive IRequestContextHandler callbacks for the extension. <see cref="IExtensionHandler.OnExtensionLoaded"/> will be
377-
/// called on load success or <see cref="IExtensionHandler.OnExtensionLoadFailed"/> will be called on load failure.
378-
/// If the extension specifies a background script via the "background" manifest key then <see cref="IExtensionHandler.OnBeforeBackgroundBrowser"/>
376+
/// loader will receive IRequestContextHandler callbacks for the extension. <see cref="IExtensionHandler::OnExtensionLoaded"/> will be
377+
/// called on load success or <see cref="IExtensionHandler::OnExtensionLoadFailed"/> will be called on load failure.
378+
/// If the extension specifies a background script via the "background" manifest key then <see cref="IExtensionHandler::OnBeforeBackgroundBrowser"/>
379379
/// will be called to create the background browser. See that method for additional information about background scripts.
380380
/// For visible extension views the client application should evaluate the manifest to determine the correct extension URL to load and then pass
381381
/// that URL to the IBrowserHost.CreateBrowser* function after the extension has loaded. For example, the client can look for the "browser_action"
@@ -384,7 +384,7 @@ namespace CefSharp
384384
/// Visit chrome://extensions-support for the list of extension APIs currently supported by CEF. - Main frame navigation to non-extension
385385
/// content is blocked.
386386
/// - Pinch-zooming is disabled.
387-
/// - <see cref="IBrowserHost.GetExtension"/> returns the hosted extension.
387+
/// - <see cref="IBrowserHost::GetExtension"/> returns the hosted extension.
388388
/// - CefBrowserHost::IsBackgroundHost returns true for background hosts. See https://developer.chrome.com/extensions for extension implementation and usage documentation.
389389
/// </summary>
390390
/// <param name="rootDirectory">If extension resources will be read from disk using the default load implementation then rootDirectoy

0 commit comments

Comments
 (0)