Skip to content

Commit

Permalink
chore: xml comment fixes for appium#733
Browse files Browse the repository at this point in the history
  • Loading branch information
dragojs committed Mar 3, 2024
1 parent e2fd45e commit 472937f
Show file tree
Hide file tree
Showing 14 changed files with 51 additions and 55 deletions.
2 changes: 1 addition & 1 deletion src/Appium.Net/Appium/Android/AndroidDriver.cs
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ public ConnectionType ConnectionType

#endregion Connection Type

#region Device Kesys
#region Device Keys

public void PressKeyCode(int keyCode, int metastate = -1) =>
AppiumCommandExecutionHelper.PressKeyCode(this, keyCode, metastate);
Expand Down
4 changes: 2 additions & 2 deletions src/Appium.Net/Appium/Android/Interfaces/IPushesFiles.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public interface IPushesFiles : IInteractsWithFiles
/// </summary>
/// <param name="pathOnDevice">Path to file to write data to on remote device</param>
/// <param name="stringData">A string to write to remote device</param>
void PushFile(string pathOnDevice, string base64Data);
void PushFile(string pathOnDevice, string stringData);

/// <summary>
/// Saves base64 encoded data as a file on the remote mobile device.
Expand All @@ -37,7 +37,7 @@ public interface IPushesFiles : IInteractsWithFiles
/// Saves given file as a file on the remote mobile device.
/// </summary>
/// <param name="pathOnDevice">Path to file to write data to on remote device</param>
/// <param name="base64Data">A file to write to remote device</param>
/// <param name="file">A file to write to remote device</param>
void PushFile(string pathOnDevice, FileInfo file);
}
}
1 change: 0 additions & 1 deletion src/Appium.Net/Appium/AppiumCommand.cs
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,6 @@ internal static ICommandExecutor Merge(ICommandExecutor repo)
/// <param name="commandType">type of command (get/post/delete)</param>
/// <param name="command">Command</param>
/// <param name="apiEndpoint">api endpoint</param>
/// <summary>
public AppiumCommand(string commandType, string command, string apiEndpoint)
{
CommandType = commandType;
Expand Down
2 changes: 1 addition & 1 deletion src/Appium.Net/Appium/Interfaces/IFindsByFluentSelector.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ public interface IFindsByFluentSelector<out W> where W : IWebElement
/// <param name="by">is a string selector</param>
/// <param name="value">is a value of the given selector</param>
/// <returns>a list of elements</returns>
IReadOnlyCollection<W> FindElements(string selector, string value);
IReadOnlyCollection<W> FindElements(string by, string value);
}
}
2 changes: 1 addition & 1 deletion src/Appium.Net/Appium/Interfaces/IHidesKeyboard.cs
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public interface IHidesKeyboard
/// <summary>
/// Whether or not the soft keyboard is shown
/// </summary>
/// <returns><see cref="true"/> if keyboard is shown, <see cref="false"/> if not.</returns>
/// <returns><see langword="true"/> if keyboard is shown, <see langword="false"/> if not.</returns>
bool IsKeyboardShown();
}
}
6 changes: 3 additions & 3 deletions src/Appium.Net/Appium/Interfaces/IInteractsWithApps.cs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public interface IInteractsWithApps : IExecuteMethod
/// <summary>
/// Checks If an App Is Installed.
/// </summary>
/// <param name="appPath">a string containing the bundle id.</param>
/// <param name="bundleId">a string containing the bundle id.</param>
/// <return>a boolean indicating if the app is installed.</return>
bool IsAppInstalled(string bundleId);

Expand All @@ -51,13 +51,13 @@ public interface IInteractsWithApps : IExecuteMethod
/// <summary>
/// Removes an App.
/// </summary>
/// <param name="appPath">a string containing the id of the app.</param>
/// <param name="appId">a string containing the id of the app.</param>
void RemoveApp(string appId);

/// <summary>
/// Activates the given app by moving to the foreground if it is running in the background or starting it if it is not running yet.
/// </summary>
/// <param name="appPath">a string containing the id of the app.</param>
/// <param name="appId">a string containing the id of the app.</param>
void ActivateApp(string appId);

/// <summary>
Expand Down
3 changes: 1 addition & 2 deletions src/Appium.Net/Appium/Interfaces/INetworkActions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public interface INetworkActions
/// Switch the state of data service (Emulator Only)
/// (For Android) This API does not work for Android API level 21+
/// because it requires system or carrier privileged permission,
/// and Android <= 21 does not support granting permissions.
/// and Android &lt;= 21 does not support granting permissions.
/// </summary>
void ToggleData();

Expand Down Expand Up @@ -59,7 +59,6 @@ public interface INetworkActions
/// <summary>
/// Sets GSM signal strength (Emulator only)
/// </summary>
/// <param name=""></param>
/// <param name="gsmSignalStrength"></param>
void SetGsmSignalStrength(GsmSignalStrength gsmSignalStrength);

Expand Down
11 changes: 5 additions & 6 deletions src/Appium.Net/Appium/Interfaces/ITouchAction.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,19 @@ namespace OpenQA.Selenium.Appium.Interfaces
public interface ITouchAction
{
/// <summary>
/// Press at the specified location in the element until the context menu appears.
/// Long press at the location in the element.
/// </summary>
/// <param name="element">The target element.</param>
/// <param name="x">The x coordinate relative to the element.</param>
/// <param name="y">The y coordinate relative to the element.</param>
/// <returns>A self-reference to this <see cref="ITouchAction"/>.</returns>
ITouchAction LongPress(IWebElement el, double? x = null, double? y = null);
ITouchAction LongPress(IWebElement element, double? x = null, double? y = null);

/// <summary>
/// Press at the specified location until the context menu appears.
/// Long press at the location specified by the coordinates.
/// </summary>
/// <param name="element">The target element.</param>
/// <param name="x">The x coordinate relative to the element.</param>
/// <param name="y">The y coordinate relative to the element.</param>
/// <param name="x">The x absolute coordinate.</param>
/// <param name="y">The y absolute coordinate.</param>
/// <returns>A self-reference to this <see cref="ITouchAction"/>.</returns>
ITouchAction LongPress(double x, double y);

Expand Down
36 changes: 18 additions & 18 deletions src/Appium.Net/Appium/MobileBy.cs
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@ public override ReadOnlyCollection<IWebElement> FindElements(ISearchContext cont
/// <summary>
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
/// that searches for elements by accessibility id
/// About Android accessibility
/// <see cref="https://developer.android.com/intl/ru/training/accessibility/accessible-app.html"/>
/// About iOS accessibility
/// <see cref="https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIAccessibilityIdentification_Protocol/index.html"/>
/// <br>About Android accessibility</br>
/// <see href="https://developer.android.com/intl/ru/training/accessibility/accessible-app.html"/>
/// <br>About iOS accessibility</br>
/// <see href="https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIAccessibilityIdentification_Protocol/index.html"/>
/// </summary>
/// <param name="selector">The selector to use in finding the element.</param>
/// <returns></returns>
Expand All @@ -77,7 +77,7 @@ public override ReadOnlyCollection<IWebElement> FindElements(ISearchContext cont
/// <summary>
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
/// that searches for elements using Android UI automation framework.
/// <see cref="http://developer.android.com/intl/ru/tools/testing-support-library/index.html#uia-apis"/>
/// <see href="http://developer.android.com/intl/ru/tools/testing-support-library/index.html#uia-apis"/>
/// </summary>
/// <param name="selector">The selector to use in finding the element.</param>
/// <returns></returns>
Expand All @@ -86,7 +86,7 @@ public override ReadOnlyCollection<IWebElement> FindElements(ISearchContext cont
/// <summary>
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
/// that searches for elements using Android UI automation framework.
/// <see cref="http://developer.android.com/intl/ru/tools/testing-support-library/index.html#uia-apis"/>
/// <see href="http://developer.android.com/intl/ru/tools/testing-support-library/index.html#uia-apis"/>
/// </summary>
/// <param name="selector">The selector to use in finding the element.</param>
/// <returns></returns>
Expand All @@ -96,7 +96,7 @@ public static By AndroidUIAutomator(IUiAutomatorStatementBuilder selector) =>
/// <summary>
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
/// that searches for elements using Espresso's Data Matcher.
/// <see cref="http://appium.io/docs/en/writing-running-appium/android/espresso-datamatcher-selector"/>
/// <see href="http://appium.io/docs/en/writing-running-appium/android/espresso-datamatcher-selector"/>
/// </summary>
/// <param name="selector">The selector to use in finding the element.</param>
/// <returns></returns>
Expand All @@ -105,7 +105,7 @@ public static By AndroidUIAutomator(IUiAutomatorStatementBuilder selector) =>
/// <summary>
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
/// that searches for elements using Espresso's View Matcher.
/// <see cref="https://developer.android.com/training/testing/espresso/basics#finding-view"/>
/// <see href="https://developer.android.com/training/testing/espresso/basics#finding-view"/>
/// </summary>
/// <param name="selector">The selector to use in finding the element.</param>
/// <returns></returns>
Expand All @@ -114,7 +114,7 @@ public static By AndroidUIAutomator(IUiAutomatorStatementBuilder selector) =>
/// <summary>
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
/// that searches for elements using iOS UI automation.
/// <see cref="https://developer.apple.com/library/tvos/documentation/DeveloperTools/Conceptual/InstrumentsUserGuide/UIAutomation.html"/>
/// <see href="https://developer.apple.com/library/tvos/documentation/DeveloperTools/Conceptual/InstrumentsUserGuide/UIAutomation.html"/>
/// </summary>
/// <param name="selector">The selector to use in finding the element.</param>
/// <returns></returns>
Expand All @@ -141,10 +141,10 @@ public static By AndroidUIAutomator(IUiAutomatorStatementBuilder selector) =>

/// <summary>
/// Finds element when the Accessibility Id selector has the specified value.
/// About Android accessibility
/// <see cref="https://developer.android.com/intl/ru/training/accessibility/accessible-app.html"/>
/// About iOS accessibility
/// <see cref="https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIAccessibilityIdentification_Protocol/index.html"/>
/// <br>About Android accessibility </br>
/// <see href="https://developer.android.com/intl/ru/training/accessibility/accessible-app.html"/>
/// <br>About iOS accessibility</br>
/// <see href="https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIAccessibilityIdentification_Protocol/index.html"/>
/// </summary>
public class ByAccessibilityId : MobileBy
{
Expand Down Expand Up @@ -176,7 +176,7 @@ public override string ToString() =>

/// <summary>
/// Finds element when the Android UIAutomator selector has the specified value.
/// <see cref="http://developer.android.com/intl/ru/tools/testing-support-library/index.html#uia-apis"/>
/// <see href="http://developer.android.com/intl/ru/tools/testing-support-library/index.html#uia-apis"/>
/// </summary>
public class ByAndroidUIAutomator : MobileBy
{
Expand Down Expand Up @@ -217,7 +217,7 @@ public override string ToString() =>

/// <summary>
/// Finds element when the Espresso's Data Matcher selector has the specified value.
/// <see cref="http://appium.io/docs/en/writing-running-appium/android/espresso-datamatcher-selector"/>
/// <see href="http://appium.io/docs/en/writing-running-appium/android/espresso-datamatcher-selector"/>
/// </summary>
public class ByAndroidDataMatcher : MobileBy
{
Expand Down Expand Up @@ -249,7 +249,7 @@ public override string ToString() =>

/// <summary>
/// Finds element when the Espresso's View Matcher selector has the specified value.
/// <see cref="https://developer.android.com/training/testing/espresso/basics#finding-view"/>
/// <see href="https://developer.android.com/training/testing/espresso/basics#finding-view"/>
/// </summary>
public class ByAndroidViewMatcher : MobileBy
{
Expand Down Expand Up @@ -281,7 +281,7 @@ public override string ToString() =>

/// <summary>
/// Finds element when the Ios UIAutomation selector has the specified value.
/// <see cref="https://developer.apple.com/library/tvos/documentation/DeveloperTools/Conceptual/InstrumentsUserGuide/UIAutomation.html"/>
/// <see href="https://developer.apple.com/library/tvos/documentation/DeveloperTools/Conceptual/InstrumentsUserGuide/UIAutomation.html"/>
/// </summary>
public class ByIosUIAutomation : MobileBy
{
Expand Down Expand Up @@ -428,7 +428,7 @@ public class ByImage : MobileBy
/// <summary>
/// Initializes a new instance of the <see cref="ByImage"/> class.
/// </summary>
/// <param name="base64Template">base64-encoded template image string.</param>
/// <param name="selector">base64-encoded template image string.</param>
public ByImage(string selector) : base(selector, MobileSelector.Image)
{
}
Expand Down
4 changes: 2 additions & 2 deletions src/Appium.Net/Appium/MultiAction/MultiAction.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ public class MultiAction : IMultiAction
private IPerformsTouchActions TouchActionPerformer;

/// <summary>
/// Initializes a new instance of the <see cref="MultiTouchAction"/> class.
/// Initializes a new instance of the <see cref="MultiAction"/> class.
/// </summary>
/// <param name="driver">The <see cref="IWebDriver"/> the driver to be used.</param>
/// <param name="touchActionPerformer">The <see cref="IWebDriver"/> the driver to be used.</param>
public MultiAction(IPerformsTouchActions touchActionPerformer)
{
this.TouchActionPerformer = touchActionPerformer;
Expand Down
27 changes: 13 additions & 14 deletions src/Appium.Net/Appium/MultiAction/TouchAction.cs
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ public TouchAction(IPerformsTouchActions touchActionPerformer)
/// Press at the specified location in the element until the context menu appears.
/// </summary>
/// <param name="element">The target element.</param>
/// <param name=x>The x coordinate relative to the element.</param>
/// <param name=y>The y coordinate relative to the element.</param>
/// <param name="x">The x coordinate relative to the element.</param>
/// <param name="y">The y coordinate relative to the element.</param>
/// <returns>A self-reference to this <see cref="ITouchAction"/>.</returns>
public ITouchAction LongPress(IWebElement element, double? x = null, double? y = null)
{
Expand All @@ -112,11 +112,10 @@ public ITouchAction LongPress(IWebElement element, double? x = null, double? y =
}

/// <summary>
/// Press at the specified location in the element until the context menu appears.
/// Long press at the location specified by the coordinates.
/// </summary>
/// <param name="element">The target element.</param>
/// <param name=x>The x coordinate relative to the element.</param>
/// <param name=y>The y coordinate relative to the element.</param>
/// <param name="x">The x absolute coordinate.</param>
/// <param name="y">The y absolute coordinate.</param>
/// <returns>A self-reference to this <see cref="ITouchAction"/>.</returns>
public ITouchAction LongPress(double x, double y)
{
Expand All @@ -132,8 +131,8 @@ public ITouchAction LongPress(double x, double y)
/// Move to the specified location in the element.
/// </summary>
/// <param name="element">The target element.</param>
/// <param name=x>The x coordinate relative to the element.</param>
/// <param name=y>The y coordinate relative to the element.</param>
/// <param name="x">The x coordinate relative to the element.</param>
/// <param name="y">The y coordinate relative to the element.</param>
/// <returns>A self-reference to this <see cref="ITouchAction"/>.</returns>
public ITouchAction MoveTo(IWebElement element, double? x = null, double? y = null)
{
Expand All @@ -149,8 +148,8 @@ public ITouchAction MoveTo(IWebElement element, double? x = null, double? y = nu
/// <summary>
/// Move to the specified location.
/// </summary>
/// <param name=x>The x coordinate.</param>
/// <param name=y>The y coordinate.</param>
/// <param name="x">The x coordinate.</param>
/// <param name="y">The y coordinate.</param>
/// <returns>A self-reference to this <see cref="ITouchAction"/>.</returns>
public ITouchAction MoveTo(double x, double y)
{
Expand All @@ -166,8 +165,8 @@ public ITouchAction MoveTo(double x, double y)
/// Press at the specified location in the element.
/// </summary>
/// <param name="element">The target element.</param>
/// <param name=x>The x coordinate relative to the element.</param>
/// <param name=y>The y coordinate relative to the element.</param>
/// <param name="x">The x coordinate relative to the element.</param>
/// <param name="y">The y coordinate relative to the element.</param>
/// <returns>A self-reference to this <see cref="ITouchAction"/>.</returns>
public ITouchAction Press(IWebElement element, double? x = null, double? y = null)
{
Expand All @@ -183,8 +182,8 @@ public ITouchAction Press(IWebElement element, double? x = null, double? y = nul
/// <summary>
/// Press at the specified location.
/// </summary>
/// <param name=x>The x coordinate.</param>
/// <param name=y>The y coordinate.</param>
/// <param name="x">The x coordinate.</param>
/// <param name="y">The y coordinate.</param>
/// <returns>A self-reference to this <see cref="ITouchAction"/>.</returns>
public ITouchAction Press(double x, double y)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Appium.Net/Appium/Service/AppiumCommandExecutor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public Response Execute(Command commandToExecute)
}
return result;
}
catch (Exception e)
catch (Exception)
{
HandleCommandException(commandToExecute);

Expand Down
Loading

0 comments on commit 472937f

Please sign in to comment.