You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
• Updates API documentation for Selenium .NET WebDriver version 4.36.0
• Adds comprehensive DevTools V140 API documentation including adapters for Animation, Browser, Debugger, and session domains
• Removes outdated DevTools V137 documentation files (2000+ files deleted)
• Updates BiDi module documentation with new WebExtension namespace and interface implementations
• Includes detailed method signatures, parameters, and cross-references for all new DevTools classes
• Auto-generated documentation update maintaining consistency across the API reference
Diagram Walkthrough
flowchart LR
V137["DevTools V137 Documentation"] -- "Remove" --> Deleted["Deleted Files"]
V140["DevTools V140 Classes"] -- "Add" --> NewDocs["New API Documentation"]
BiDi["BiDi Module"] -- "Update" --> Enhanced["Enhanced Documentation"]
NewDocs --> Final["Selenium 4.36.0 API Docs"]
Enhanced --> Final
• Added complete HTML documentation for the DebuggerAdapter class in DevTools V140 • Includes constructor, properties, methods, and events documentation • Provides comprehensive API reference with method signatures and parameters
• Added complete HTML documentation for DevToolsSessionDomains class for Chrome DevTools Protocol version 140 • Includes constructor documentation and properties for all DevTools domain adapters (Accessibility, Animation, Audits, etc.) • Contains method documentation for PopulateCommandResponseTypeMap()
• Added complete HTML documentation for ScriptFailedToParseEventArgs class • Documents all properties including ScriptId, Url, StartLine, EndLine, ExecutionContextId, Hash, etc. • Provides detailed property descriptions and type information for debugger script parsing failure events
• Added complete HTML documentation for the BrowserAdapter class in DevTools V140 Browser domain • Includes constructor, properties, methods, and events documentation with detailed parameter descriptions
• Provides comprehensive API reference with inheritance information and cross-references
• Added complete HTML documentation for the AnimationAdapter class in DevTools V140 Animation domain • Includes constructor, properties, methods, and events documentation with detailed parameter descriptions
• Provides comprehensive API reference with inheritance information and cross-references
[To ensure code accuracy, apply this suggestion manually]
Suggestion importance[1-10]: 6
__
Why: The suggestion correctly identifies that the "View source" links are broken because they point to a bazel-bin directory, which is a significant issue for documentation usability.
Low
Fix incorrect URL encoding
In the meta tag's content attribute, replace the HTML entity ' with its correct URL-encoded equivalent, %27, to ensure the link functions correctly.
Why: The suggestion correctly identifies that using an HTML entity ' within a URL's query parameter is not standard practice and could lead to issues. Replacing it with the proper URL encoding %27 improves the robustness and correctness of the generated link.
Low
Learned best practice
Standardize nullable usage in docs
Standardize the return types to non-nullable in documentation if responses are always provided; otherwise document when null can be returned and under what conditions.
[To ensure code accuracy, apply this suggestion manually]
Suggestion importance[1-10]: 6
__
Why:
Relevant best practice - Keep API and documentation accurate and consistent by avoiding optional/nullable annotations that don't match the actual API behavior across methods.
Low
General
Remove placeholder content from URL
Remove the placeholder value parameter from the docfx:docurl meta tag's content URL to provide a clean slate for documentation contributors.
Why: The suggestion correctly identifies placeholder text in the docfx:docurl meta tag and proposes replacing it with the actual summary, which improves the experience for contributors.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
This PR updates the API documentation for version 4.36.0-all.
PR Type
Documentation
Description
• Updates API documentation for Selenium .NET WebDriver version 4.36.0
• Adds comprehensive DevTools V140 API documentation including adapters for Animation, Browser, Debugger, and session domains
• Removes outdated DevTools V137 documentation files (2000+ files deleted)
• Updates BiDi module documentation with new WebExtension namespace and interface implementations
• Includes detailed method signatures, parameters, and cross-references for all new DevTools classes
• Auto-generated documentation update maintaining consistency across the API reference
Diagram Walkthrough
File Walkthrough
9 files
OpenQA.Selenium.DevTools.V140.Debugger.DebuggerAdapter.html
Add DevTools V140 DebuggerAdapter API documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V140.Debugger.DebuggerAdapter.html
• Added complete HTML documentation for the
DebuggerAdapterclass inDevTools V140
• Includes constructor, properties, methods, and events
documentation
• Provides comprehensive API reference with method
signatures and parameters
OpenQA.Selenium.BiDi.BrowsingContext.BoxClipRectangle.html
Update BoxClipRectangle source line referencesdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.BrowsingContext.BoxClipRectangle.html
• Updated source code line references from line 55 to line 56
•
Modified GitHub source links to point to the correct line numbers
OpenQA.Selenium.BiDi.Module.html
Add WebExtensionModule to Module inheritance documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.Module.html
• Added
WebExtensionModuleto the list of derived types• Expanded the
inheritance hierarchy documentation
OpenQA.Selenium.DevTools.V140.DevToolsSessionDomains.html
Add DevTools V140 session domains API documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V140.DevToolsSessionDomains.html
• Added complete HTML documentation for DevToolsSessionDomains class
for Chrome DevTools Protocol version 140
• Includes constructor
documentation and properties for all DevTools domain adapters
(Accessibility, Animation, Audits, etc.)
• Contains method
documentation for PopulateCommandResponseTypeMap()
OpenQA.Selenium.DevTools.V140.Debugger.ScriptFailedToParseEventArgs.html
Add DevTools V140 debugger script parse failure event documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V140.Debugger.ScriptFailedToParseEventArgs.html
• Added complete HTML documentation for ScriptFailedToParseEventArgs
class
• Documents all properties including ScriptId, Url, StartLine,
EndLine, ExecutionContextId, Hash, etc.
• Provides detailed property
descriptions and type information for debugger script parsing failure
events
OpenQA.Selenium.BiDi.BrowsingContext.html
Add BiDi browsing context interface documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.BrowsingContext.html
• Added new interfaces section with IBaseNavigationInfo interface
reference
OpenQA.Selenium.BiDi.html
Add BiDi WebExtension namespace documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.html
• Added new WebExtension namespace reference to the BiDi API
documentation
OpenQA.Selenium.DevTools.V140.Browser.BrowserAdapter.html
Add DevTools V140 Browser adapter documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V140.Browser.BrowserAdapter.html
• Added complete HTML documentation for the
BrowserAdapterclass inDevTools V140 Browser domain
• Includes constructor, properties,
methods, and events documentation with detailed parameter descriptions
• Provides comprehensive API reference with inheritance information
and cross-references
OpenQA.Selenium.DevTools.V140.Animation.AnimationAdapter.html
Add DevTools V140 Animation adapter documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V140.Animation.AnimationAdapter.html
• Added complete HTML documentation for the
AnimationAdapterclass inDevTools V140 Animation domain
• Includes constructor, properties,
methods, and events documentation with detailed parameter descriptions
• Provides comprehensive API reference with inheritance information
and cross-references
1 files
OpenQA.Selenium.BiDi.BrowsingContext.NavigationInfo.html
Update NavigationInfo to implement IBaseNavigationInfo interfacedocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.BrowsingContext.NavigationInfo.html
• Updated class signature to implement
IBaseNavigationInfointerface•
Added interface implementation to the inheritance hierarchy
documentation
101 files