Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Update XML comments for various drivers classes #763

Merged
merged 1 commit into from
Mar 24, 2024
Merged

docs: Update XML comments for various drivers classes #763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/Appium.Net/Appium/Android/AndroidDriver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ public AndroidDriver(AppiumServiceBuilder builder, DriverOptions driverOptions,
/// <summary>
/// Initializes a new instance of the AndroidDriver class using the specified remote address and Appium options
/// </summary>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub).</param>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/).</param>
/// <param name="driverOptions">An <see cref="DriverOptions"/> object containing the Appium options.</param>
public AndroidDriver(Uri remoteAddress, DriverOptions driverOptions)
: base(remoteAddress, SetPlatformToCapabilities(driverOptions, Platform))
Expand All @@ -107,7 +107,7 @@ public AndroidDriver(AppiumLocalService service, DriverOptions driverOptions)
/// <summary>
/// Initializes a new instance of the AndroidDriver class using the specified remote address, Appium options, and command timeout.
/// </summary>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub).</param>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/).</param>
/// <param name="driverOptions">An <see cref="DriverOptions"/> object containing the Appium options.</param>
/// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
public AndroidDriver(Uri remoteAddress, DriverOptions driverOptions, TimeSpan commandTimeout)
Expand All @@ -131,7 +131,7 @@ public AndroidDriver(AppiumLocalService service, DriverOptions driverOptions,
/// <summary>
/// Initializes a new instance of the AndroidDriver class using the specified remote address, Appium options and AppiumClientConfig.
/// </summary>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub).</param>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/).</param>
/// <param name="driverOptions">An <see cref="DriverOptions"/> object containing the Appium options.</param>
/// <param name="clientConfig">An instance of <see cref="AppiumClientConfig"/></param>
public AndroidDriver(Uri remoteAddress, DriverOptions driverOptions, AppiumClientConfig clientConfig)
Expand All @@ -153,7 +153,7 @@ public AndroidDriver(AppiumLocalService service, DriverOptions driverOptions, Ap
/// <summary>
/// Initializes a new instance of the AndroidDriver class using the specified remote address, Appium options, command timeout and AppiumClientConfig.
/// </summary>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub).</param>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/).</param>
/// <param name="driverOptions">An <see cref="DriverOptions"/> object containing the Appium options.</param>
/// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
/// <param name="clientConfig">An instance of <see cref="AppiumClientConfig"/></param>
Expand Down
6 changes: 3 additions & 3 deletions src/Appium.Net/Appium/Mac/MacDriver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public MacDriver(AppiumServiceBuilder builder, AppiumOptions AppiumOptions, Time
/// <summary>
/// Initializes a new instance of the MacDriver class using the specified remote address and Appium options
/// </summary>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub).</param>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/).</param>
/// <param name="AppiumOptions">An <see cref="AppiumOptions"/> object containing the Appium options.</param>
public MacDriver(Uri remoteAddress, AppiumOptions AppiumOptions)
: base(remoteAddress, SetPlatformToCapabilities(AppiumOptions, Platform))
Expand All @@ -95,7 +95,7 @@ public MacDriver(AppiumLocalService service, AppiumOptions AppiumOptions)
/// <summary>
/// Initializes a new instance of the MacDriver class using the specified remote address, Appium options, and command timeout.
/// </summary>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub).</param>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/).</param>
/// <param name="AppiumOptions">An <see cref="AppiumOptions"/> object containing the Appium options.</param>
/// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
public MacDriver(Uri remoteAddress, AppiumOptions AppiumOptions, TimeSpan commandTimeout)
Expand Down Expand Up @@ -139,7 +139,7 @@ public MacDriver(AppiumLocalService service, DriverOptions driverOptions, Appium
/// <summary>
/// Initializes a new instance of the MacDriver class using the specified remote address, Appium options, command timeout and AppiumClientConfig.
/// </summary>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub).</param>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/).</param>
/// <param name="driverOptions">An <see cref="DriverOptions"/> object containing the Appium options.</param>
/// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
/// <param name="clientConfig">An instance of <see cref="AppiumClientConfig"/></param>
Expand Down
12 changes: 6 additions & 6 deletions src/Appium.Net/Appium/iOS/IOSDriver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ public IOSDriver(AppiumServiceBuilder builder, DriverOptions driverOptions, Time
/// <summary>
/// Initializes a new instance of the IOSDriver class using the specified remote address and Appium options
/// </summary>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub).</param>
/// <param name="DriverOptions">An <see cref="DriverOptions"/> object containing the Appium options.</param>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/).</param>
/// <param name="driverOptions">An <see cref="DriverOptions"/> object containing the Appium options.</param>
public IOSDriver(Uri remoteAddress, DriverOptions driverOptions)
: base(remoteAddress, SetPlatformToCapabilities(driverOptions, Platform))
{
Expand All @@ -100,8 +100,8 @@ public IOSDriver(AppiumLocalService service, DriverOptions driverOptions)
/// <summary>
/// Initializes a new instance of the IOSDriver class using the specified remote address, Appium options, and command timeout.
/// </summary>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub).</param>
/// <param name="DriverOptions">An <see cref="DriverOptions"/> object containing the Appium options.</param>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/).</param>
/// <param name="driverOptions">An <see cref="DriverOptions"/> object containing the Appium options.</param>
/// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
public IOSDriver(Uri remoteAddress, DriverOptions driverOptions, TimeSpan commandTimeout)
: base(remoteAddress, SetPlatformToCapabilities(driverOptions, Platform), commandTimeout)
Expand All @@ -123,7 +123,7 @@ public IOSDriver(AppiumLocalService service, DriverOptions driverOptions, TimeSp
/// <summary>
/// Initializes a new instance of the IOSDriver class using the specified remote address, Appium options and AppiumClientConfig.
/// </summary>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub).</param>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/).</param>
/// <param name="driverOptions">An <see cref="DriverOptions"/> object containing the Appium options.</param>
/// <param name="clientConfig">An instance of <see cref="AppiumClientConfig"/></param>
public IOSDriver(Uri remoteAddress, DriverOptions driverOptions, AppiumClientConfig clientConfig)
Expand All @@ -145,7 +145,7 @@ public IOSDriver(AppiumLocalService service, DriverOptions driverOptions, Appium
/// <summary>
/// Initializes a new instance of the IOSDriver class using the specified remote address, Appium options, command timeout and AppiumClientConfig.
/// </summary>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub).</param>
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/).</param>
/// <param name="driverOptions">An <see cref="DriverOptions"/> object containing the Appium options.</param>
/// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
/// <param name="clientConfig">An instance of <see cref="AppiumClientConfig"/></param>
Expand Down