Skip to content

Commit db32cda

Browse files
authored
Fix broken xml doc links (#1627)
* fix broken xml docs links since there are properties matching those type names, the types need to be fully qualified * fix more docs links * Update Page.cs
1 parent 6925502 commit db32cda

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

lib/PuppeteerSharp/Browser.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ public BrowserContext[] BrowserContexts()
235235

236236
/// <summary>
237237
/// Returns a Task which resolves to an array of all open pages.
238-
/// Non visible pages, such as <c>"background_page"</c>, will not be listed here. You can find them using <see cref="Target.PageAsync"/>
238+
/// Non visible pages, such as <c>"background_page"</c>, will not be listed here. You can find them using <see cref="PuppeteerSharp.Target.PageAsync"/>
239239
/// </summary>
240240
/// <returns>Task which resolves to an array of all open pages inside the Browser.
241241
/// In case of multiple browser contexts, the method will return an array with all the pages in all browser contexts.

lib/PuppeteerSharp/BrowserContext.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using System;
1+
using System;
22
using System.Collections.Generic;
33
using System.Linq;
44
using System.Threading.Tasks;
@@ -8,7 +8,7 @@ namespace PuppeteerSharp
88
{
99
/// <summary>
1010
/// BrowserContexts provide a way to operate multiple independent browser sessions. When a browser is launched, it has
11-
/// a single <see cref="BrowserContext"/> used by default. The method <see cref="Browser.NewPageAsync"/> creates a <see cref="Page"/> in the default <see cref="BrowserContext"/>
11+
/// a single <see cref="BrowserContext"/> used by default. The method <see cref="PuppeteerSharp.Browser.NewPageAsync"/> creates a <see cref="Page"/> in the default <see cref="BrowserContext"/>
1212
/// </summary>
1313
public class BrowserContext
1414
{

lib/PuppeteerSharp/MessageException.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
namespace PuppeteerSharp
55
{
66
/// <summary>
7-
/// Exception thrown by <seealso cref="CDPSession.SendAsync(string, object)"/>
7+
/// Exception thrown by <seealso cref="CDPSession.SendAsync{T}(string, object)"/>
88
/// </summary>
99
public class MessageException : PuppeteerException
1010
{

lib/PuppeteerSharp/Page.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ private Page(
118118
public event EventHandler<MetricEventArgs> Metrics;
119119

120120
/// <summary>
121-
/// Raised when a JavaScript dialog appears, such as <c>alert</c>, <c>prompt</c>, <c>confirm</c> or <c>beforeunload</c>. Puppeteer can respond to the dialog via <see cref="Dialog"/>'s <see cref="Dialog.Accept(string)"/> or <see cref="Dialog.Dismiss"/> methods.
121+
/// Raised when a JavaScript dialog appears, such as <c>alert</c>, <c>prompt</c>, <c>confirm</c> or <c>beforeunload</c>. Puppeteer can respond to the dialog via <see cref="Dialog"/>'s <see cref="PuppeteerSharp.Dialog.Accept(string)"/> or <see cref="PuppeteerSharp.Dialog.Dismiss"/> methods.
122122
/// </summary>
123123
public event EventHandler<DialogEventArgs> Dialog;
124124

@@ -399,7 +399,7 @@ void clientDisconnected(object sender, EventArgs e)
399399
/// <returns>The task.</returns>
400400
/// <param name="options">Geolocation options.</param>
401401
/// <remarks>
402-
/// Consider using <seealso cref="BrowserContext.OverridePermissionsAsync(string, IEnumerable{OverridePermission})"/> to grant permissions for the page to read its geolocation.
402+
/// Consider using <seealso cref="PuppeteerSharp.BrowserContext.OverridePermissionsAsync(string, IEnumerable{OverridePermission})"/> to grant permissions for the page to read its geolocation.
403403
/// </remarks>
404404
public Task SetGeolocationAsync(GeolocationOption options)
405405
{
@@ -601,8 +601,8 @@ public async Task<JSHandle> QueryObjectsAsync(JSHandle prototypeHandle)
601601
}
602602

603603
/// <summary>
604-
/// Activating request interception enables <see cref="Request.AbortAsync(RequestAbortErrorCode)">request.AbortAsync</see>,
605-
/// <see cref="Request.ContinueAsync(Payload)">request.ContinueAsync</see> and <see cref="Request.RespondAsync(ResponseData)">request.RespondAsync</see> methods.
604+
/// Activating request interception enables <see cref="PuppeteerSharp.Request.AbortAsync(RequestAbortErrorCode)">request.AbortAsync</see>,
605+
/// <see cref="PuppeteerSharp.Request.ContinueAsync(Payload)">request.ContinueAsync</see> and <see cref="PuppeteerSharp.Request.RespondAsync(ResponseData)">request.RespondAsync</see> methods.
606606
/// </summary>
607607
/// <returns>The request interception task.</returns>
608608
/// <param name="value">Whether to enable request interception..</param>
@@ -858,7 +858,7 @@ public Task ExposeFunctionAsync<T1, T2, T3, T4, TResult>(string name, Func<T1, T
858858
/// - the main resource failed to load.
859859
///
860860
/// <see cref="GoToAsync(string, int?, WaitUntilNavigation[])"/> will not throw an error when any valid HTTP status code is returned by the remote server,
861-
/// including 404 "Not Found" and 500 "Internal Server Error". The status code for such responses can be retrieved by calling <see cref="Response.Status"/>
861+
/// including 404 "Not Found" and 500 "Internal Server Error". The status code for such responses can be retrieved by calling <see cref="PuppeteerSharp.Response.Status"/>
862862
///
863863
/// > **NOTE** <see cref="GoToAsync(string, int?, WaitUntilNavigation[])"/> either throws an error or returns a main resource response.
864864
/// The only exceptions are navigation to `about:blank` or navigation to the same URL with a different hash, which would succeed and return `null`.
@@ -1358,7 +1358,7 @@ public Task SetCacheEnabledAsync(bool enabled = true)
13581358
/// <param name="options"></param>
13591359
/// <exception cref="SelectorException">If there's no element matching <paramref name="selector"/></exception>
13601360
/// <remarks>
1361-
/// To press a special key, like <c>Control</c> or <c>ArrowDown</c> use <see cref="Keyboard.PressAsync(string, PressOptions)"/>
1361+
/// To press a special key, like <c>Control</c> or <c>ArrowDown</c> use <see cref="PuppeteerSharp.Input.Keyboard.PressAsync(string, PressOptions)"/>
13621362
/// </remarks>
13631363
/// <example>
13641364
/// <code>

lib/PuppeteerSharp/Target.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ internal Target(
7171
/// <value>The URL.</value>
7272
public string Url => TargetInfo.Url;
7373
/// <summary>
74-
/// Gets the type. It will be <see cref="TargetInfo.Type"/>.
74+
/// Gets the type. It will be <see cref="PuppeteerSharp.TargetInfo.Type"/>.
7575
/// Can be `"page"`, `"background_page"`, `"service_worker"`, `"shared_worker"`, `"browser"` or `"other"`.
7676
/// </summary>
7777
/// <value>The type.</value>

0 commit comments

Comments
 (0)