Skip to content

Conversation

@selenium-ci
Copy link
Member

@selenium-ci selenium-ci commented Apr 5, 2025

User description

This PR updates the API documentation for version 4.31.0-all.


PR Type

Documentation


Description

  • Updated API documentation for Selenium version 4.31.0-all.

  • Added new HTML documentation pages for various classes, including DebuggerAdapter, DevToolsSessionDomains, BrowserAdapter, and Node.

  • Updated and corrected references, links, and metadata in existing documentation files.

  • Deleted outdated documentation files for version 4.32.0 and replaced them with updated ones for version 4.31.0.


Changes walkthrough 📝

Relevant files
Documentation
8 files
OpenQA.Selenium.DevTools.V135.Debugger.DebuggerAdapter.html
Added HTML documentation for DebuggerAdapter class.           

docs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V135.Debugger.DebuggerAdapter.html

  • Added a new HTML documentation page for the DebuggerAdapter class.
  • Includes detailed descriptions of methods, properties, constructors,
    and events.
  • Provides links to source code and related documentation.
  • Implements a structured layout with sections for inheritance,
    parameters, and return types.
  • +1838/-0
    OpenQA.Selenium.Support.UI.PopupWindowFinder.html
    Updated line references in PopupWindowFinder documentation.

    docs/api/dotnet/support/OpenQA.Selenium.Support.UI.PopupWindowFinder.html

  • Updated source code line references in the PopupWindowFinder
    documentation.
  • Adjusted links to reflect updated line numbers in the source code.
  • Minor corrections to ensure accurate navigation to the source.
  • +7/-7     
    OpenQA.Selenium.DevTools.V135.DevToolsSessionDomains.html
    Added documentation for `DevToolsSessionDomains` class in Selenium.

    docs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V135.DevToolsSessionDomains.html

  • Added a new HTML documentation file for the DevToolsSessionDomains
    class.
  • Includes detailed descriptions of properties, methods, and inheritance
    for the class.
  • Provides links to related namespaces and assemblies.
  • Contains metadata for rendering and navigation in the documentation
    site.
  • +1946/-0
    OpenQA.Selenium.DevTools.V135.Debugger.ScriptFailedToParseEventArgs.html
    Added documentation for ScriptFailedToParseEventArgs class in
    Selenium.

    docs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V135.Debugger.ScriptFailedToParseEventArgs.html

  • Introduced a new HTML documentation file for the
    ScriptFailedToParseEventArgs class.
  • Details properties such as ScriptId, Url, and StartLine with
    descriptions and data types.
  • Includes inheritance and metadata for seamless integration into the
    documentation site.
  • Provides links to related classes and namespaces.
  • +785/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.CaptureScreenshotOptions.html
    Updated property type reference in CaptureScreenshotOptions
    documentation.

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

  • Updated the property type reference for Origin in the
    CaptureScreenshotOptions class.
  • Changed the type from CaptureScreenshotOptions.ScreenshotOrigin to
    ScreenshotOrigin.
  • Adjusted the related documentation links to reflect the updated type.
  • +2/-2     
    OpenQA.Selenium.DevTools.V135.Browser.BrowserAdapter.html
    Added API documentation for `BrowserAdapter` class in Selenium.

    docs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V135.Browser.BrowserAdapter.html

  • Added a new HTML documentation file for the BrowserAdapter class.
  • Includes detailed descriptions of properties, methods, constructors,
    and events.
  • Provides links to source code and related classes.
  • Implements metadata and styling for rendering the documentation.
  • +1100/-0
    OpenQA.Selenium.DevTools.V135.DOM.Node.html
    Added API documentation for `Node` class in Selenium.       

    docs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V135.DOM.Node.html

  • Added a new HTML documentation file for the Node class.
  • Includes detailed descriptions of properties and their metadata.
  • Provides links to source code and related classes.
  • Implements metadata and styling for rendering the documentation.
  • +1260/-0
    OpenQA.Selenium.BiDi.Modules.Script.EvaluateResult.html
    Fixed derived class links in `EvaluateResult` documentation.

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

  • Corrected links for derived classes in the EvaluateResult
    documentation.
  • Updated references to EvaluateResult.Exception and
    EvaluateResult.Success to EvaluateResultException and
    EvaluateResultSuccess.
  • +2/-2     
    Additional files
    101 files
    index.json [link]   
    manifest.json [link]   
    OpenQA.Selenium.BiDi.BiDiException.html +33/-0   
    OpenQA.Selenium.BiDi.Communication.CommandOptions.html +0/-2     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.AccessibilityLocator.AccessibilityLocatorValue.html +0/-248 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.AccessibilityLocator.html +6/-6     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.AccessibilityValue.html +248/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextScriptModule.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.CaptureScreenshotOptions.ScreenshotOrigin.html +0/-151 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.ContextLocator.ContextLocatorValue.html +0/-252 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.ContextLocator.html +10/-10 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.ContextValue.html +252/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.CssLocator.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.InnerTextLocator.Match.html +0/-151 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.InnerTextLocator.html +9/-9     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.MatchType.html +151/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.ScreenshotOrigin.html +151/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.XPathLocator.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.html +7/-7     
    OpenQA.Selenium.BiDi.Modules.Network.AuthCredentials.Basic.html +0/-287 
    OpenQA.Selenium.BiDi.Modules.Network.AuthCredentials.html +104/-9 
    OpenQA.Selenium.BiDi.Modules.Network.ContinueWithAuthCancelCredentialsOptions.html +191/-0 
    OpenQA.Selenium.BiDi.Modules.Network.ContinueWithAuthCredentialsOptions.html +189/-0 
    OpenQA.Selenium.BiDi.Modules.Network.ContinueWithAuthDefaultCredentialsOptions.html +191/-0 
    OpenQA.Selenium.BiDi.Modules.Network.ContinueWithAuthNoCredentialsOptions.html +196/-0 
    OpenQA.Selenium.BiDi.Modules.Network.ContinueWithAuthOptions.html +9/-2     
    OpenQA.Selenium.BiDi.Modules.Network.ContinueWithCancelledAuthOptions.html +0/-187 
    OpenQA.Selenium.BiDi.Modules.Network.ContinueWithDefaultAuthOptions.html +0/-187 
    OpenQA.Selenium.BiDi.Modules.Network.Request.html +12/-12 
    OpenQA.Selenium.BiDi.Modules.Network.html +11/-7   
    OpenQA.Selenium.BiDi.Modules.Script.ArrayLocalValue.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.Script.BigIntLocalValue.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.Script.BooleanLocalValue.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.Script.ChannelLocalValue.ChannelProperties.html +0/-314 
    OpenQA.Selenium.BiDi.Modules.Script.ChannelLocalValue.html +9/-9     
    OpenQA.Selenium.BiDi.Modules.Script.ChannelProperties.html +314/-0 
    OpenQA.Selenium.BiDi.Modules.Script.DateLocalValue.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.Script.EvaluateResult.Exception.html +0/-287 
    OpenQA.Selenium.BiDi.Modules.Script.EvaluateResult.Success.html +0/-327 
    OpenQA.Selenium.BiDi.Modules.Script.EvaluateResultException.html +287/-0 
    OpenQA.Selenium.BiDi.Modules.Script.EvaluateResultSuccess.html +327/-0 
    OpenQA.Selenium.BiDi.Modules.Script.ExceptionDetails.html +7/-7     
    OpenQA.Selenium.BiDi.Modules.Script.LocalValue.html +81/-9   
    OpenQA.Selenium.BiDi.Modules.Script.MapLocalValue.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.Script.Mode.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.Script.NullLocalValue.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.Script.NumberLocalValue.html +5/-5     
    OpenQA.Selenium.BiDi.Modules.Script.ObjectLocalValue.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.Script.PrimitiveProtocolLocalValue.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.Script.PrimitiveProtocolRemoteValue.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.Script.RegExpLocalValue.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.Script.ScriptEvaluateException.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.Script.SetLocalValue.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.Script.StringLocalValue.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.Script.UndefinedLocalValue.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.Script.WindowProxyProperties.html +252/-0 
    OpenQA.Selenium.BiDi.Modules.Script.WindowProxyRemoteValue.Properties.html +0/-252 
    OpenQA.Selenium.BiDi.Modules.Script.WindowProxyRemoteValue.html +6/-6     
    OpenQA.Selenium.BiDi.Modules.Script.html +5/-5     
    OpenQA.Selenium.Chromium.ChromiumDriver.html +8/-8     
    OpenQA.Selenium.Command.html +7/-7     
    OpenQA.Selenium.DevTools.DevToolsDomains.html +1/-1     
    OpenQA.Selenium.DevTools.DevToolsSessionDomains.html +1/-1     
    OpenQA.Selenium.DevTools.JavaScript.html +1/-1     
    OpenQA.Selenium.DevTools.Log.html +1/-1     
    OpenQA.Selenium.DevTools.Network.html +1/-1     
    OpenQA.Selenium.DevTools.Target.html +1/-1     
    OpenQA.Selenium.DevTools.V132.Accessibility.AXNode.html +0/-618 
    OpenQA.Selenium.DevTools.V132.Accessibility.AXProperty.html +0/-244 
    OpenQA.Selenium.DevTools.V132.Accessibility.AXPropertyName.html +0/-313 
    OpenQA.Selenium.DevTools.V132.Accessibility.AXRelatedNode.html +0/-279 
    OpenQA.Selenium.DevTools.V132.Accessibility.AXValue.html +0/-313 
    OpenQA.Selenium.DevTools.V132.Accessibility.AXValueNativeSourceType.html +0/-189 
    OpenQA.Selenium.DevTools.V132.Accessibility.AXValueSource.html +0/-483 
    OpenQA.Selenium.DevTools.V132.Accessibility.AXValueSourceType.html +0/-173 
    OpenQA.Selenium.DevTools.V132.Accessibility.AXValueType.html +0/-217 
    OpenQA.Selenium.DevTools.V132.Accessibility.AccessibilityAdapter.html +0/-670 
    OpenQA.Selenium.DevTools.V132.Accessibility.DisableCommandResponse.html +0/-188 
    OpenQA.Selenium.DevTools.V132.Accessibility.DisableCommandSettings.html +0/-217 
    OpenQA.Selenium.DevTools.V132.Accessibility.EnableCommandResponse.html +0/-188 
    OpenQA.Selenium.DevTools.V132.Accessibility.EnableCommandSettings.html +0/-217 
    OpenQA.Selenium.DevTools.V132.Accessibility.GetAXNodeAndAncestorsCommandResponse.html +0/-225 
    OpenQA.Selenium.DevTools.V132.Accessibility.GetAXNodeAndAncestorsCommandSettings.html +0/-319 
    OpenQA.Selenium.DevTools.V132.Accessibility.GetChildAXNodesCommandResponse.html +0/-225 
    OpenQA.Selenium.DevTools.V132.Accessibility.GetChildAXNodesCommandSettings.html +0/-284 
    OpenQA.Selenium.DevTools.V132.Accessibility.GetFullAXTreeCommandResponse.html +0/-225 
    OpenQA.Selenium.DevTools.V132.Accessibility.GetFullAXTreeCommandSettings.html +0/-285 
    OpenQA.Selenium.DevTools.V132.Accessibility.GetPartialAXTreeCommandResponse.html +0/-225 
    OpenQA.Selenium.DevTools.V132.Accessibility.GetPartialAXTreeCommandSettings.html +0/-353 
    OpenQA.Selenium.DevTools.V132.Accessibility.GetRootAXNodeCommandResponse.html +0/-225 
    OpenQA.Selenium.DevTools.V132.Accessibility.GetRootAXNodeCommandSettings.html +0/-251 
    OpenQA.Selenium.DevTools.V132.Accessibility.LoadCompleteEventArgs.html +0/-215 
    OpenQA.Selenium.DevTools.V132.Accessibility.NodesUpdatedEventArgs.html +0/-215 
    OpenQA.Selenium.DevTools.V132.Accessibility.QueryAXTreeCommandResponse.html +0/-225 
    OpenQA.Selenium.DevTools.V132.Accessibility.QueryAXTreeCommandSettings.html +0/-387 
    OpenQA.Selenium.DevTools.V132.Accessibility.html +0/-265 
    OpenQA.Selenium.DevTools.V132.Animation.Animation.html +0/-544 
    OpenQA.Selenium.DevTools.V132.Animation.AnimationAdapter.html +0/-818 
    OpenQA.Selenium.DevTools.V132.Animation.AnimationCanceledEventArgs.html +0/-215 
    Additional files not shown

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • @selenium-ci selenium-ci added the B-docs API Docs; see other repo for website documentation label Apr 5, 2025
    @selenium-ci selenium-ci merged commit 2cdd81b into gh-pages Apr 5, 2025
    @selenium-ci selenium-ci deleted the api-docs-4.31.0 branch April 5, 2025 05:12
    @qodo-merge-pro
    Copy link
    Contributor

    qodo-merge-pro bot commented Apr 5, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    @qodo-merge-pro
    Copy link
    Contributor

    qodo-merge-pro bot commented Apr 5, 2025

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    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

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    2 participants