Skip to content

Commit cd1a239

Browse files
committed
Core - Improve DevTools Client xml doc
1 parent c9c624c commit cd1a239

Some content is hidden

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

58 files changed

+428
-60
lines changed

CefSharp/DevTools/Accessibility/AXProperty.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ namespace CefSharp.DevTools.Accessibility
99
[System.Runtime.Serialization.DataContractAttribute]
1010
public class AXProperty : CefSharp.DevTools.DevToolsDomainEntityBase
1111
{
12+
/// <summary>
13+
/// The name of this property.
14+
/// </summary>
1215
public CefSharp.DevTools.Accessibility.AXPropertyName Name
1316
{
1417
get

CefSharp/DevTools/Accessibility/AXValue.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ namespace CefSharp.DevTools.Accessibility
99
[System.Runtime.Serialization.DataContractAttribute]
1010
public class AXValue : CefSharp.DevTools.DevToolsDomainEntityBase
1111
{
12+
/// <summary>
13+
/// The type of this value.
14+
/// </summary>
1215
public CefSharp.DevTools.Accessibility.AXValueType Type
1316
{
1417
get

CefSharp/DevTools/Accessibility/AXValueSource.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ namespace CefSharp.DevTools.Accessibility
99
[System.Runtime.Serialization.DataContractAttribute]
1010
public class AXValueSource : CefSharp.DevTools.DevToolsDomainEntityBase
1111
{
12+
/// <summary>
13+
/// What type of source this is.
14+
/// </summary>
1215
public CefSharp.DevTools.Accessibility.AXValueSourceType Type
1316
{
1417
get
@@ -72,6 +75,9 @@ public bool? Superseded
7275
set;
7376
}
7477

78+
/// <summary>
79+
/// The native markup source for this value, e.g. a <label> element.
80+
/// </summary>
7581
public CefSharp.DevTools.Accessibility.AXValueNativeSourceType? NativeSource
7682
{
7783
get

CefSharp/DevTools/Audits/BlockedByResponseIssueDetails.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ public CefSharp.DevTools.Audits.AffectedFrame Frame
3131
set;
3232
}
3333

34+
/// <summary>
35+
/// Reason
36+
/// </summary>
3437
public CefSharp.DevTools.Audits.BlockedByResponseReason Reason
3538
{
3639
get

CefSharp/DevTools/Audits/HeavyAdIssueDetails.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ namespace CefSharp.DevTools.Audits
99
[System.Runtime.Serialization.DataContractAttribute]
1010
public class HeavyAdIssueDetails : CefSharp.DevTools.DevToolsDomainEntityBase
1111
{
12+
/// <summary>
13+
/// The resolution status, either blocking the content or warning.
14+
/// </summary>
1215
public CefSharp.DevTools.Audits.HeavyAdResolutionStatus Resolution
1316
{
1417
get
@@ -32,6 +35,9 @@ internal string resolution
3235
set;
3336
}
3437

38+
/// <summary>
39+
/// The reason the ad was blocked, total network or cpu or peak cpu.
40+
/// </summary>
3541
public CefSharp.DevTools.Audits.HeavyAdReason Reason
3642
{
3743
get

CefSharp/DevTools/Audits/InspectorIssue.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ namespace CefSharp.DevTools.Audits
99
[System.Runtime.Serialization.DataContractAttribute]
1010
public class InspectorIssue : CefSharp.DevTools.DevToolsDomainEntityBase
1111
{
12+
/// <summary>
13+
/// Code
14+
/// </summary>
1215
public CefSharp.DevTools.Audits.InspectorIssueCode Code
1316
{
1417
get

CefSharp/DevTools/Audits/MixedContentIssueDetails.cs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ namespace CefSharp.DevTools.Audits
99
[System.Runtime.Serialization.DataContractAttribute]
1010
public class MixedContentIssueDetails : CefSharp.DevTools.DevToolsDomainEntityBase
1111
{
12+
/// <summary>
13+
/// The type of resource causing the mixed content issue (css, js, iframe,
14+
/// form,...). Marked as optional because it is mapped to from
15+
/// blink::mojom::RequestContextType, which will be replaced
16+
/// by network::mojom::RequestDestination
17+
/// </summary>
1218
public CefSharp.DevTools.Audits.MixedContentResourceType? ResourceType
1319
{
1420
get
@@ -35,6 +41,9 @@ internal string resourceType
3541
set;
3642
}
3743

44+
/// <summary>
45+
/// The way the mixed content issue is being resolved.
46+
/// </summary>
3847
public CefSharp.DevTools.Audits.MixedContentResolutionStatus ResolutionStatus
3948
{
4049
get

CefSharp/DevTools/Audits/SameSiteCookieIssueDetails.cs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ public CefSharp.DevTools.Audits.AffectedCookie Cookie
2121
set;
2222
}
2323

24+
/// <summary>
25+
/// CookieWarningReasons
26+
/// </summary>
2427
public CefSharp.DevTools.Audits.SameSiteCookieWarningReason[] CookieWarningReasons
2528
{
2629
get
@@ -44,6 +47,9 @@ internal string cookieWarningReasons
4447
set;
4548
}
4649

50+
/// <summary>
51+
/// CookieExclusionReasons
52+
/// </summary>
4753
public CefSharp.DevTools.Audits.SameSiteCookieExclusionReason[] CookieExclusionReasons
4854
{
4955
get
@@ -67,6 +73,10 @@ internal string cookieExclusionReasons
6773
set;
6874
}
6975

76+
/// <summary>
77+
/// Optionally identifies the site-for-cookies and the cookie url, which
78+
/// may be used by the front-end as additional context.
79+
/// </summary>
7080
public CefSharp.DevTools.Audits.SameSiteCookieOperation Operation
7181
{
7282
get

CefSharp/DevTools/BackgroundService/BackgroundServiceEvent.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ public string ServiceWorkerRegistrationId
3939
set;
4040
}
4141

42+
/// <summary>
43+
/// The Background Service this event belongs to.
44+
/// </summary>
4245
public CefSharp.DevTools.BackgroundService.ServiceName Service
4346
{
4447
get

CefSharp/DevTools/Browser/Bounds.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ public int? Height
4949
set;
5050
}
5151

52+
/// <summary>
53+
/// The window state. Default to normal.
54+
/// </summary>
5255
public CefSharp.DevTools.Browser.WindowState? WindowState
5356
{
5457
get

0 commit comments

Comments
 (0)