[rb] mark low level bidi implementation as private api

Author: titusfortner

rb/lib/selenium/webdriver/bidi/browser.rb

@@ -20,6 +20,13 @@
 module Selenium
   module WebDriver
     class BiDi
+      #
+      # BiDi Implementation of the Browser Module
+      # Continue to use functionality from existing `driver.manager.window` method
+      #
+      # @api private
+      #
+
       class Browser
         Window = Struct.new(:handle, :active, :height, :width, :x, :y, :state) do
           def active?

rb/lib/selenium/webdriver/bidi/browsing_context.rb

@@ -20,7 +20,8 @@
 module Selenium
   module WebDriver
     class BiDi
-      # Implements the browsingContext Module of the WebDriver-BiDi specification
+      # Implements the BrowsingContext Module of the WebDriver-BiDi specification
+      # Continue to use functionality from existing `driver.navigate` method
       #
       # @api private
       #

rb/lib/selenium/webdriver/bidi/log_handler.rb

@@ -20,6 +20,11 @@
 module Selenium
   module WebDriver
     class BiDi
+      # Implements the Log of the WebDriver-BiDi specification
+      # This functionality should be accessed through `driver.script` method
+      #
+      # @api private
+      #
       class LogHandler
         ConsoleLogEntry = BiDi::Struct.new(:level, :text, :timestamp, :stack_trace, :type, :source, :method, :args)
         JavaScriptLogEntry = BiDi::Struct.new(:level, :text, :timestamp, :stack_trace, :type, :source)

rb/lib/selenium/webdriver/bidi/network.rb

@@ -21,6 +21,12 @@
 module Selenium
   module WebDriver
     class BiDi
+      # Implements the Navigation Module of the WebDriver-BiDi specification
+      # Continue to use functionality from existing `driver.navigate` method
+      #
+      # @api private
+      #
+
       class Network
         EVENTS = {
           before_request: 'network.beforeRequestSent',

rb/lib/selenium/webdriver/bidi/network/cookies.rb

@@ -20,6 +20,10 @@
 module Selenium
   module WebDriver
     class BiDi
+      #
+      # @api private
+      #
+
       class Cookies < Hash
         def as_json
           map do |name, val|

rb/lib/selenium/webdriver/bidi/network/credentials.rb

@@ -20,6 +20,10 @@
 module Selenium
   module WebDriver
     class BiDi
+      #
+      # @api private
+      #
+
       class Credentials
         attr_accessor :username, :password
 

rb/lib/selenium/webdriver/bidi/network/headers.rb

@@ -20,6 +20,10 @@
 module Selenium
   module WebDriver
     class BiDi
+      #
+      # @api private
+      #
+
       class Headers < Hash
         def as_json
           map do |name, val|

rb/lib/selenium/webdriver/bidi/network/intercepted_auth.rb

@@ -20,6 +20,10 @@
 module Selenium
   module WebDriver
     class BiDi
+      #
+      # @api private
+      #
+
       class InterceptedAuth < InterceptedItem
         def authenticate(username, password)
           network.continue_with_auth(id, username, password)

rb/lib/selenium/webdriver/bidi/network/intercepted_item.rb

@@ -20,6 +20,10 @@
 module Selenium
   module WebDriver
     class BiDi
+      #
+      # @api private
+      #
+
       class InterceptedItem
         attr_reader :network, :request
 

rb/lib/selenium/webdriver/bidi/network/intercepted_request.rb

@@ -23,6 +23,10 @@
 module Selenium
   module WebDriver
     class BiDi
+      #
+      # @api private
+      #
+
       class InterceptedRequest < InterceptedItem
         attr_accessor :method, :url
         attr_reader :body