Skip to content

Conversation

@diemol
Copy link
Member

@diemol diemol commented Sep 23, 2024

User description

Thanks for contributing to Selenium!
A PR well described will help maintainers to quickly review and merge it

Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, help reviewers by making them as simple and short as possible.

Description

Motivation and Context

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have read the contributing document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

PR Type

Documentation


Description

  • Added new HTML documentation files for various classes and enums in the .NET API, including BrowsingContextModule, Broker, BrowsingContext, BrowsingContextNetworkModule, BiDi, NetworkModule, FetchTimingInfo, and UserPromptType.
  • Each documentation file includes detailed sections on constructors, methods, properties, and inheritance information.
  • Provided links to source code and related classes/interfaces for better navigation and understanding.
  • Deleted outdated documentation files related to older versions of DevTools adapters and modules.

Changes walkthrough 📝

Relevant files
Documentation
8 files
OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextModule.html
Add HTML documentation for BrowsingContextModule class     

docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextModule.html

  • Added a new HTML documentation file for the BrowsingContextModule
    class.
  • Includes detailed sections on constructors, methods, and parameters.
  • Provides links to source code and related classes/interfaces.
  • +1510/-0
    OpenQA.Selenium.BiDi.Communication.Broker.html
    Add HTML documentation for Broker class                                   

    docs/api/dotnet/OpenQA.Selenium.BiDi.Communication.Broker.html

  • Added a new HTML documentation file for the Broker class.
  • Contains information on class inheritance and implemented interfaces.
  • Details constructors and methods with parameters and return types.
  • +494/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContext.html
    Add HTML documentation for BrowsingContext class                 

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContext.html

  • Added a new HTML documentation file for the BrowsingContext class.
  • Includes detailed sections on properties and methods of the
    BrowsingContext class.
  • Provides links to source code and related documentation.
  • +1432/-0
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextNetworkModule.html
    Add HTML documentation for BrowsingContextNetworkModule class

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextNetworkModule.html

  • Added a new HTML documentation file for the
    BrowsingContextNetworkModule class.
  • Includes detailed sections on constructors and methods of the
    BrowsingContextNetworkModule class.
  • Provides links to source code and related documentation.
  • +636/-0 
    OpenQA.Selenium.BiDi.BiDi.html
    Add HTML documentation for BiDi class in .NET API               

    docs/api/dotnet/OpenQA.Selenium.BiDi.BiDi.html

  • Added a new HTML documentation file for the BiDi class.
  • Includes class details, properties, methods, and inheritance
    information.
  • Provides links to source code and related documentation.
  • +823/-0 
    OpenQA.Selenium.BiDi.Modules.Network.NetworkModule.html
    Add HTML documentation for NetworkModule class in .NET API

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.NetworkModule.html

  • Added a new HTML documentation file for the NetworkModule class.
  • Details class constructors, methods, and inheritance.
  • Includes links to source code and related documentation.
  • +632/-0 
    OpenQA.Selenium.BiDi.Modules.Network.FetchTimingInfo.html
    Add HTML documentation for FetchTimingInfo class in .NET API

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.FetchTimingInfo.html

  • Added a new HTML documentation file for the FetchTimingInfo class.
  • Describes class properties, constructors, and inheritance.
  • Provides links to source code and related documentation.
  • +643/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.UserPromptType.html
    Add HTML documentation for UserPromptType enum in .NET API

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.UserPromptType.html

  • Added a new HTML documentation file for the UserPromptType enum.
  • Lists enum fields and their values.
  • Includes links to source code and related documentation.
  • +150/-0 
    Additional files (token-limit)
    101 files
    OpenQA.Selenium.BiDi.Modules.Network.ResponseData.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.ResponseData.html

    ...

    +609/-0 
    OpenQA.Selenium.BiDi.Modules.Network.Intercept.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.Intercept.html

    ...

    +549/-0 
    OpenQA.Selenium.BiDi.Modules.Script.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.html

    ...

    +460/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextScriptModule.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextScriptModule.html

    ...

    +415/-0 
    OpenQA.Selenium.BiDi.Modules.Network.Cookie.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.Cookie.html

    ...

    +510/-0 
    OpenQA.Selenium.BiDi.Modules.Network.RequestData.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.RequestData.html

    ...

    +478/-0 
    OpenQA.Selenium.BiDi.Modules.Script.NodeProperties.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.NodeProperties.html

    ...

    +504/-0 
    OpenQA.Selenium.BiDi.Modules.Network.BaseParametersEventArgs.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.BaseParametersEventArgs.html

    ...

    +435/-0 
    OpenQA.Selenium.BiDi.Modules.Network.SetCookieHeader.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.SetCookieHeader.html

    ...

    +497/-0 
    OpenQA.Selenium.BiDi.Modules.Network.Request.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.Request.html

    ...

    +459/-0 
    OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.html

    ...

    +404/-0 
    OpenQA.Selenium.BiDi.Modules.Session.Capability.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Session.Capability.html

    ...

    +474/-0 
    OpenQA.Selenium.BiDi.Modules.Storage.PartialCookie.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Storage.PartialCookie.html

    ...

    +468/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextInfo.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextInfo.html

    ...

    +392/-0 
    OpenQA.Selenium.BiDi.Modules.Storage.CookieFilter.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Storage.CookieFilter.html

    ...

    +454/-0 
    OpenQA.Selenium.BiDi.Modules.Script.RemoteValue.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.RemoteValue.html

    ...

    +355/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.PrintOptions.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.PrintOptions.html

    ...

    +403/-0 
    OpenQA.Selenium.BiDi.Modules.Browser.BrowserModule.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Browser.BrowserModule.html

    ...

    +354/-0 
    OpenQA.Selenium.BiDi.Communication.Transport.WebSocketTransport.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Communication.Transport.WebSocketTransport.html

    ...

    +362/-0 
    OpenQA.Selenium.BiDi.Modules.Log.BaseLogEntry.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Log.BaseLogEntry.html

    ...

    +360/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.html

    ...

    +331/-0 
    OpenQA.Selenium.BiDi.Modules.Network.BeforeRequestSentEventArgs.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.BeforeRequestSentEventArgs.html

    ...

    +291/-0 
    OpenQA.Selenium.Cookie.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.Cookie.html

    ...

    +28/-25 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.InnerTextLocator.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.InnerTextLocator.html

    ...

    +351/-0 
    OpenQA.Selenium.BiDi.Modules.Log.ConsoleLogEntry.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Log.ConsoleLogEntry.html

    ...

    +309/-0 
    OpenQA.Selenium.BiDi.Modules.Network.AuthRequiredEventArgs.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.AuthRequiredEventArgs.html

    ...

    +291/-0 
    OpenQA.Selenium.BiDi.Modules.Network.ResponseCompletedEventArgs.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.ResponseCompletedEventArgs.html

    ...

    +291/-0 
    OpenQA.Selenium.BiDi.Modules.Network.ResponseStartedEventArgs.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.ResponseStartedEventArgs.html

    ...

    +291/-0 
    OpenQA.Selenium.BiDi.Modules.Network.FetchErrorEventArgs.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.FetchErrorEventArgs.html

    ...

    +291/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextStorageModule.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextStorageModule.html

    ...

    +322/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.UserPromptOpenedEventArgs.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.UserPromptOpenedEventArgs.html

    ...

    +326/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.NavigationInfo.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.NavigationInfo.html

    ...

    +327/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BoxClipRectangle.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BoxClipRectangle.html

    ...

    +348/-0 
    OpenQA.Selenium.BiDi.Modules.Network.Initiator.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.Initiator.html

    ...

    +371/-0 
    OpenQA.Selenium.BiDi.Modules.Network.ContinueResponseOptions.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.ContinueResponseOptions.html

    ...

    +341/-0 
    OpenQA.Selenium.BiDi.Modules.Network.ProvideResponseOptions.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.ProvideResponseOptions.html

    ...

    +341/-0 
    OpenQA.Selenium.BiDi.Modules.Network.ContinueRequestOptions.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.ContinueRequestOptions.html

    ...

    +341/-0 
    OpenQA.Selenium.BiDi.Modules.Network.UrlPatternPattern.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.UrlPatternPattern.html

    ...

    +344/-0 
    OpenQA.Selenium.BiDi.Modules.Session.CapabilityRequest.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Session.CapabilityRequest.html

    ...

    +361/-0 
    OpenQA.Selenium.BiDi.Modules.Storage.StorageModule.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Storage.StorageModule.html

    ...

    +324/-0 
    OpenQA.Selenium.BiDi.Modules.Script.CallFunctionOptions.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.CallFunctionOptions.html

    ...

    +341/-0 
    OpenQA.Selenium.BiDi.Modules.Script.LocalValue.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.LocalValue.html

    ...

    +318/-0 
    OpenQA.Selenium.BiDi.Modules.Script.ExceptionDetails.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.ExceptionDetails.html

    ...

    +346/-0 
    OpenQA.Selenium.BiDi.Modules.Script.StackFrame.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.StackFrame.html

    ...

    +346/-0 
    OpenQA.Selenium.BiDi.Modules.Script.ScriptEvaluateException.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.ScriptEvaluateException.html

    ...

    +340/-0 
    OpenQA.Selenium.BiDi.Modules.Session.ManualProxyConfiguration.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Session.ManualProxyConfiguration.html

    ...

    +338/-0 
    OpenQA.Selenium.BiDi.Communication.EventHandler.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Communication.EventHandler.html

    ...

    +347/-0 
    OpenQA.Selenium.BiDi.Modules.Script.BaseRealmInfo.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.BaseRealmInfo.html

    ...

    +302/-0 
    OpenQA.Selenium.BiDi.Modules.Script.WindowRealmInfo.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.WindowRealmInfo.html

    ...

    +299/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.Locator.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.Locator.html

    ...

    +309/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextLogModule.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextLogModule.html

    ...

    +288/-0 
    OpenQA.Selenium.BiDi.Communication.CommandOptions.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Communication.CommandOptions.html

    ...

    +255/-0 
    OpenQA.Selenium.BiDi.Modules.Network.UrlPattern.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.UrlPattern.html

    ...

    +311/-0 
    OpenQA.Selenium.BiDi.Modules.Input.KeySourceActions.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Input.KeySourceActions.html

    ...

    +321/-0 
    OpenQA.Selenium.BiDi.Modules.Script.DedicatedWorkerRealmInfo.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.DedicatedWorkerRealmInfo.html

    ...

    +268/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.UserPromptClosedEventArgs.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.UserPromptClosedEventArgs.html

    ...

    +293/-0 
    OpenQA.Selenium.BiDi.Modules.Script.AddPreloadScriptOptions.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.AddPreloadScriptOptions.html

    ...

    +309/-0 
    OpenQA.Selenium.BiDi.Modules.Script.WindowProxyRemoteValue.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.WindowProxyRemoteValue.html

    ...

    +314/-0 
    OpenQA.Selenium.BiDi.Modules.Script.RegExpRemoteValue.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.RegExpRemoteValue.html

    ...

    +314/-0 
    OpenQA.Selenium.BiDi.Modules.Script.DateRemoteValue.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.DateRemoteValue.html

    ...

    +314/-0 
    OpenQA.Selenium.BiDi.Modules.Script.NodeRemoteValue.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.NodeRemoteValue.html

    ...

    +312/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.PrintPageRange.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.PrintPageRange.html

    ...

    +310/-0 
    OpenQA.Selenium.BiDi.Modules.Log.LogModule.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Log.LogModule.html

    ...

    +284/-0 
    OpenQA.Selenium.BiDi.Modules.Script.NumberLocalValue.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.NumberLocalValue.html

    ...

    +294/-0 
    OpenQA.Selenium.BiDi.Modules.Script.PreloadScript.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.PreloadScript.html

    ...

    +317/-0 
    OpenQA.Selenium.DevTools.DevToolsCommandData.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.DevTools.DevToolsCommandData.html

    ...

    +28/-27 
    OpenQA.Selenium.BiDi.Modules.Network.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.html

    ...

    +284/-0 
    OpenQA.Selenium.BiDi.Modules.Script.ChannelProperties.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.ChannelProperties.html

    ...

    +309/-0 
    OpenQA.Selenium.BiDi.Modules.Script.RemoteObjectReference.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.RemoteObjectReference.html

    ...

    +285/-0 
    OpenQA.Selenium.BiDi.Modules.Input.InputModule.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Input.InputModule.html

    ...

    +284/-0 
    OpenQA.Selenium.BiDi.Modules.Script.SharedReference.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.SharedReference.html

    ...

    +285/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.LocateNodesOptions.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.LocateNodesOptions.html

    ...

    +279/-0 
    OpenQA.Selenium.BiDi.Modules.Script.ObjectRemoteValue.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.ObjectRemoteValue.html

    ...

    +279/-0 
    OpenQA.Selenium.BiDi.Modules.Network.BasicAuthCredentials.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.BasicAuthCredentials.html

    ...

    +285/-0 
    OpenQA.Selenium.BiDi.Modules.Script.HtmlCollectionRemoteValue.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.HtmlCollectionRemoteValue.html

    ...

    +279/-0 
    OpenQA.Selenium.BiDi.Modules.Storage.GetCookiesResult.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Storage.GetCookiesResult.html

    ...

    +280/-0 
    OpenQA.Selenium.BiDi.Modules.Network.AddInterceptOptions.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.AddInterceptOptions.html

    ...

    +278/-0 
    OpenQA.Selenium.BiDi.Modules.Script.MapRemoteValue.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.MapRemoteValue.html

    ...

    +279/-0 
    OpenQA.Selenium.BiDi.Modules.Script.NodeListRemoteValue.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.NodeListRemoteValue.html

    ...

    +279/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.CaptureScreenshotOptions.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.CaptureScreenshotOptions.html

    ...

    +279/-0 
    OpenQA.Selenium.BiDi.Modules.Script.ArrayRemoteValue.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.ArrayRemoteValue.html

    ...

    +279/-0 
    OpenQA.Selenium.BiDi.Modules.Script.SetRemoteValue.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.SetRemoteValue.html

    ...

    +279/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.AccessibilityLocator.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.AccessibilityLocator.html

    ...

    +258/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.CreateOptions.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.CreateOptions.html

    ...

    +279/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.GetTreeOptions.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.GetTreeOptions.html

    ...

    +278/-0 
    OpenQA.Selenium.BiDi.Modules.Log.JavascriptLogEntry.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Log.JavascriptLogEntry.html

    ...

    +239/-0 
    OpenQA.Selenium.BiDi.Modules.Script.EvaluateOptions.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.EvaluateOptions.html

    ...

    +279/-0 
    OpenQA.Selenium.BiDi.Communication.Transport.ITransport.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Communication.Transport.ITransport.html

    ...

    +269/-0 
    OpenQA.Selenium.BiDi.Modules.Script.ContextTarget.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.ContextTarget.html

    ...

    +280/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.NavigateResult.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.NavigateResult.html

    ...

    +280/-0 
    OpenQA.Selenium.BiDi.BrowsingContextEventArgs.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.BrowsingContextEventArgs.html

    ...

    +264/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.CaptureScreenshotResult.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.CaptureScreenshotResult.html

    ...

    +282/-0 
    OpenQA.Selenium.BiDi.Modules.Script.ObjectLocalValue.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.ObjectLocalValue.html

    ...

    +252/-0 
    OpenQA.Selenium.BiDi.Modules.Network.CookieHeader.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Network.CookieHeader.html

    ...

    +280/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.PrintMargin.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.PrintMargin.html

    ...

    +289/-0 
    OpenQA.Selenium.BiDi.Modules.Script.AudioWorkletRealmInfo.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.AudioWorkletRealmInfo.html

    ...

    +231/-0 
    OpenQA.Selenium.BiDi.Modules.Script.PaintWorkletRealmInfo.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.PaintWorkletRealmInfo.html

    ...

    +231/-0 
    OpenQA.Selenium.BiDi.Modules.Script.MapLocalValue.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Script.MapLocalValue.html

    ...

    +252/-0 
    OpenQA.Selenium.BiDi.Modules.Session.NewResult.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.Session.NewResult.html

    ...

    +280/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.CssLocator.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.CssLocator.html

    ...

    +258/-0 
    Additional 164 files not shown
    ...                                                                                                           

    Additional 164 files not shown

    ...

    Additional files (token-limit)extra_file_yaml =
    1 files
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.XPathLocator.html
    ...                                                                                                           

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.XPathLocator.html

    ...

    +258/-0 

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    @diemol diemol merged commit 873cbe4 into gh-pages Sep 23, 2024
    1 check passed
    @diemol diemol deleted the api-docs-selenium-4.25.0 branch September 23, 2024 21:49
    @qodo-merge-pro
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Key issues to review

    Documentation Completeness
    The newly added BrowsingContextModule class documentation lacks method descriptions and parameter explanations, which may hinder developers' understanding and usage of the API.

    Missing Property Descriptions
    The AccessibilityValue record's properties (Name and Role) lack descriptions, which could make it difficult for developers to understand their purpose and usage.

    @qodo-merge-pro
    Copy link
    Contributor

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Accessibility
    Add language attribute to the HTML tag for improved accessibility and SEO

    Add lang attribute to the html tag to specify the language of the document for
    better accessibility and SEO.

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContext.html [2]

    -<html>
    +<html lang="en">
     
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: Adding a lang attribute to the HTML tag enhances accessibility by informing assistive technologies of the document's language, and it also aids SEO by providing search engines with language context.

    9
    Enhancement
    Use a more specific and contextual page title

    Consider using a more specific title for the page, including the namespace, to
    provide better context.

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextModule.html [5]

    -<title>Class BrowsingContextModule </title>
    +<title>OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextModule Class</title>
     
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    Why: A more specific title including the namespace provides better context and clarity, which is beneficial for both SEO and user navigation.

    8
    Improve the title tag with more specific and detailed information

    Use a more specific title tag that includes the full class name and namespace for
    better clarity and searchability.

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContext.html [5]

    -<title>Class BrowsingContext </title>
    +<title>OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContext Class | Selenium WebDriver API</title>
     
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    Why: Using a more specific title tag that includes the full class name and namespace improves clarity and searchability, which is beneficial for users navigating the documentation.

    8
    Add parameter descriptions to improve method documentation

    Add parameter descriptions for the ConnectAsync method to provide information about
    the expected input.

    docs/api/dotnet/OpenQA.Selenium.BiDi.BiDi.html [300-303]

     <h4 class="section">Parameters</h4>
     <dl class="parameters">
       <dt><code>url</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
    -  <dd></dd>
    +  <dd>The WebSocket URL to connect to for BiDi communication.</dd>
     </dl>
     
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    Why: Providing parameter descriptions for the ConnectAsync method is crucial for users to understand the expected input, thereby improving the method's documentation and usability.

    8
    Add a meta description tag for better SEO and content summary

    Consider adding a meta description tag to improve SEO and provide a brief summary of
    the page content.

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextModule.html [6-7]

     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="title" content="Class BrowsingContextModule ">
    +<meta name="description" content="Documentation for the BrowsingContextModule class in the Selenium BiDi API">
     
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: Adding a meta description tag is a good practice for SEO and helps provide a brief summary of the page content, which can improve search engine visibility and user understanding.

    7
    Add a meta description tag for better SEO and content summarization

    Add a meta description tag to improve SEO and provide a brief summary of the page
    content.

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContext.html [6-7]

     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="title" content="Class BrowsingContext ">
    +<meta name="description" content="API documentation for the BrowsingContext class in Selenium WebDriver's BiDi module.">
     
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: Adding a meta description tag is a good practice for SEO and provides a brief summary of the page content, which can enhance search engine visibility and user understanding.

    7
    Add a brief description of the BiDi class to improve documentation clarity

    Consider adding a brief description or summary for the BiDi class in the <div
    class="markdown summary"> section. This would provide users with a quick overview of
    the class's purpose and functionality.

    docs/api/dotnet/OpenQA.Selenium.BiDi.BiDi.html [96]

    -<div class="markdown summary"></div>
    +<div class="markdown summary">
    +  The BiDi class represents the main entry point for Selenium's BiDirectional API, providing access to various modules and methods for interacting with the browser.
    +</div>
     
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: Adding a summary for the BiDi class enhances the documentation by providing users with a quick overview of the class's purpose and functionality, improving clarity and usability.

    7
    Add a description for the Browser property to clarify its purpose

    Add a description for the Browser property to explain its purpose and usage within
    the BiDi class.

    docs/api/dotnet/OpenQA.Selenium.BiDi.BiDi.html [164-165]

    -<div class="markdown level1 summary"></div>
    -<div class="markdown level1 conceptual"></div>
    +<div class="markdown level1 summary">Gets the BrowserModule instance for interacting with browser-specific functionality.</div>
    +<div class="markdown level1 conceptual">The Browser property provides access to browser-related operations and information through the BrowserModule.</div>
     
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: Including a description for the Browser property helps users understand its role and how it can be used within the BiDi class, enhancing the documentation's comprehensiveness.

    7
    Add Open Graph meta tags for better social media integration

    Consider adding Open Graph meta tags to improve social media sharing capabilities.

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextModule.html [7]

     <meta name="title" content="Class BrowsingContextModule ">
    +<meta property="og:title" content="BrowsingContextModule Class - Selenium BiDi API">
    +<meta property="og:type" content="website">
    +<meta property="og:url" content="https://www.selenium.dev/documentation/webdriver/bidirectional/browsing_context/">
    +<meta property="og:description" content="Documentation for the BrowsingContextModule class in the Selenium BiDi API">
     
    • Apply this suggestion
    Suggestion importance[1-10]: 6

    Why: Open Graph meta tags enhance social media sharing capabilities, making the content more appealing and informative when shared, although it is not critical for the functionality of the documentation.

    6
    Add a conceptual description for the DisposeAsync method to explain its purpose and usage

    Add a summary and conceptual description for the DisposeAsync method to explain its
    purpose and behavior.

    docs/api/dotnet/OpenQA.Selenium.BiDi.BiDi.html [366-369]

     <div class="markdown level1 summary"><p>Performs application-defined tasks associated with freeing, releasing, or
     resetting unmanaged resources asynchronously.</p>
     </div>
    -<div class="markdown level1 conceptual"></div>
    +<div class="markdown level1 conceptual">
    +<p>This method is used to properly dispose of the BiDi instance, ensuring that all associated resources are released. It should be called when the BiDi object is no longer needed to prevent resource leaks.</p>
    +</div>
     
    • Apply this suggestion
    Suggestion importance[1-10]: 6

    Why: Adding a conceptual description for the DisposeAsync method helps clarify its purpose and usage, which is beneficial for users to understand resource management in the BiDi class.

    6
    Best practice
    Add a language attribute to the html tag

    Consider adding a language attribute to the html tag to specify the document's
    language.

    docs/api/dotnet/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextModule.html [2]

    -<html>
    +<html lang="en">
     
    • Apply this suggestion
    Suggestion importance[1-10]: 5

    Why: Adding a language attribute is a best practice that improves accessibility and helps search engines and browsers understand the language of the document, though it is not crucial for the document's functionality.

    5

    💡 Need additional feedback ? start a PR chat

    @titusfortner titusfortner added B-docs API Docs; see other repo for website documentation and removed documentation labels Mar 30, 2025
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    B-docs API Docs; see other repo for website documentation Review effort [1-5]: 4

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants