Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 1ec7693

Browse files
author
SYNAPSE\dragos.losonti
committedFeb 10, 2024
chore: fixes some xml comments (appium#733)
1 parent e2fd45e commit 1ec7693

14 files changed

+51
-55
lines changed
 

‎src/Appium.Net/Appium/Android/AndroidDriver.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ public ConnectionType ConnectionType
201201

202202
#endregion Connection Type
203203

204-
#region Device Kesys
204+
#region Device Keys
205205

206206
public void PressKeyCode(int keyCode, int metastate = -1) =>
207207
AppiumCommandExecutionHelper.PressKeyCode(this, keyCode, metastate);

‎src/Appium.Net/Appium/Android/Interfaces/IPushesFiles.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public interface IPushesFiles : IInteractsWithFiles
2424
/// </summary>
2525
/// <param name="pathOnDevice">Path to file to write data to on remote device</param>
2626
/// <param name="stringData">A string to write to remote device</param>
27-
void PushFile(string pathOnDevice, string base64Data);
27+
void PushFile(string pathOnDevice, string stringData);
2828

2929
/// <summary>
3030
/// Saves base64 encoded data as a file on the remote mobile device.
@@ -37,7 +37,7 @@ public interface IPushesFiles : IInteractsWithFiles
3737
/// Saves given file as a file on the remote mobile device.
3838
/// </summary>
3939
/// <param name="pathOnDevice">Path to file to write data to on remote device</param>
40-
/// <param name="base64Data">A file to write to remote device</param>
40+
/// <param name="file">A file to write to remote device</param>
4141
void PushFile(string pathOnDevice, FileInfo file);
4242
}
4343
}

‎src/Appium.Net/Appium/AppiumCommand.cs

-1
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,6 @@ internal static ICommandExecutor Merge(ICommandExecutor repo)
273273
/// <param name="commandType">type of command (get/post/delete)</param>
274274
/// <param name="command">Command</param>
275275
/// <param name="apiEndpoint">api endpoint</param>
276-
/// <summary>
277276
public AppiumCommand(string commandType, string command, string apiEndpoint)
278277
{
279278
CommandType = commandType;

‎src/Appium.Net/Appium/Interfaces/IFindsByFluentSelector.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,6 @@ public interface IFindsByFluentSelector<out W> where W : IWebElement
3434
/// <param name="by">is a string selector</param>
3535
/// <param name="value">is a value of the given selector</param>
3636
/// <returns>a list of elements</returns>
37-
IReadOnlyCollection<W> FindElements(string selector, string value);
37+
IReadOnlyCollection<W> FindElements(string by, string value);
3838
}
3939
}

‎src/Appium.Net/Appium/Interfaces/IHidesKeyboard.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public interface IHidesKeyboard
3939
/// <summary>
4040
/// Whether or not the soft keyboard is shown
4141
/// </summary>
42-
/// <returns><see cref="true"/> if keyboard is shown, <see cref="false"/> if not.</returns>
42+
/// <returns><see langword="true"/> if keyboard is shown, <see langword="false"/> if not.</returns>
4343
bool IsKeyboardShown();
4444
}
4545
}

‎src/Appium.Net/Appium/Interfaces/IInteractsWithApps.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public interface IInteractsWithApps : IExecuteMethod
3333
/// <summary>
3434
/// Checks If an App Is Installed.
3535
/// </summary>
36-
/// <param name="appPath">a string containing the bundle id.</param>
36+
/// <param name="bundleId">a string containing the bundle id.</param>
3737
/// <return>a boolean indicating if the app is installed.</return>
3838
bool IsAppInstalled(string bundleId);
3939

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

5757
/// <summary>
5858
/// 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.
5959
/// </summary>
60-
/// <param name="appPath">a string containing the id of the app.</param>
60+
/// <param name="appId">a string containing the id of the app.</param>
6161
void ActivateApp(string appId);
6262

6363
/// <summary>

‎src/Appium.Net/Appium/Interfaces/INetworkActions.cs

+1-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public interface INetworkActions
2828
/// Switch the state of data service (Emulator Only)
2929
/// (For Android) This API does not work for Android API level 21+
3030
/// because it requires system or carrier privileged permission,
31-
/// and Android <= 21 does not support granting permissions.
31+
/// and Android &lt;= 21 does not support granting permissions.
3232
/// </summary>
3333
void ToggleData();
3434

@@ -59,7 +59,6 @@ public interface INetworkActions
5959
/// <summary>
6060
/// Sets GSM signal strength (Emulator only)
6161
/// </summary>
62-
/// <param name=""></param>
6362
/// <param name="gsmSignalStrength"></param>
6463
void SetGsmSignalStrength(GsmSignalStrength gsmSignalStrength);
6564

‎src/Appium.Net/Appium/Interfaces/ITouchAction.cs

+5-6
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,19 @@ namespace OpenQA.Selenium.Appium.Interfaces
1919
public interface ITouchAction
2020
{
2121
/// <summary>
22-
/// Press at the specified location in the element until the context menu appears.
22+
/// Press at the specified location in the element until the context menu appears.
2323
/// </summary>
2424
/// <param name="element">The target element.</param>
2525
/// <param name="x">The x coordinate relative to the element.</param>
2626
/// <param name="y">The y coordinate relative to the element.</param>
2727
/// <returns>A self-reference to this <see cref="ITouchAction"/>.</returns>
28-
ITouchAction LongPress(IWebElement el, double? x = null, double? y = null);
28+
ITouchAction LongPress(IWebElement element, double? x = null, double? y = null);
2929

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

‎src/Appium.Net/Appium/MobileBy.cs

+18-18
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,10 @@ public override ReadOnlyCollection<IWebElement> FindElements(ISearchContext cont
6565
/// <summary>
6666
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
6767
/// that searches for elements by accessibility id
68-
/// About Android accessibility
69-
/// <see cref="https://developer.android.com/intl/ru/training/accessibility/accessible-app.html"/>
70-
/// About iOS accessibility
71-
/// <see cref="https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIAccessibilityIdentification_Protocol/index.html"/>
68+
/// <br>About Android accessibility</br>
69+
/// <see href="https://developer.android.com/intl/ru/training/accessibility/accessible-app.html"/>
70+
/// <br>About iOS accessibility</br>
71+
/// <see href="https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIAccessibilityIdentification_Protocol/index.html"/>
7272
/// </summary>
7373
/// <param name="selector">The selector to use in finding the element.</param>
7474
/// <returns></returns>
@@ -77,7 +77,7 @@ public override ReadOnlyCollection<IWebElement> FindElements(ISearchContext cont
7777
/// <summary>
7878
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
7979
/// that searches for elements using Android UI automation framework.
80-
/// <see cref="http://developer.android.com/intl/ru/tools/testing-support-library/index.html#uia-apis"/>
80+
/// <see href="http://developer.android.com/intl/ru/tools/testing-support-library/index.html#uia-apis"/>
8181
/// </summary>
8282
/// <param name="selector">The selector to use in finding the element.</param>
8383
/// <returns></returns>
@@ -86,7 +86,7 @@ public override ReadOnlyCollection<IWebElement> FindElements(ISearchContext cont
8686
/// <summary>
8787
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
8888
/// that searches for elements using Android UI automation framework.
89-
/// <see cref="http://developer.android.com/intl/ru/tools/testing-support-library/index.html#uia-apis"/>
89+
/// <see href="http://developer.android.com/intl/ru/tools/testing-support-library/index.html#uia-apis"/>
9090
/// </summary>
9191
/// <param name="selector">The selector to use in finding the element.</param>
9292
/// <returns></returns>
@@ -96,7 +96,7 @@ public static By AndroidUIAutomator(IUiAutomatorStatementBuilder selector) =>
9696
/// <summary>
9797
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
9898
/// that searches for elements using Espresso's Data Matcher.
99-
/// <see cref="http://appium.io/docs/en/writing-running-appium/android/espresso-datamatcher-selector"/>
99+
/// <see href="http://appium.io/docs/en/writing-running-appium/android/espresso-datamatcher-selector"/>
100100
/// </summary>
101101
/// <param name="selector">The selector to use in finding the element.</param>
102102
/// <returns></returns>
@@ -105,7 +105,7 @@ public static By AndroidUIAutomator(IUiAutomatorStatementBuilder selector) =>
105105
/// <summary>
106106
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
107107
/// that searches for elements using Espresso's View Matcher.
108-
/// <see cref="https://developer.android.com/training/testing/espresso/basics#finding-view"/>
108+
/// <see href="https://developer.android.com/training/testing/espresso/basics#finding-view"/>
109109
/// </summary>
110110
/// <param name="selector">The selector to use in finding the element.</param>
111111
/// <returns></returns>
@@ -114,7 +114,7 @@ public static By AndroidUIAutomator(IUiAutomatorStatementBuilder selector) =>
114114
/// <summary>
115115
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
116116
/// that searches for elements using iOS UI automation.
117-
/// <see cref="https://developer.apple.com/library/tvos/documentation/DeveloperTools/Conceptual/InstrumentsUserGuide/UIAutomation.html"/>
117+
/// <see href="https://developer.apple.com/library/tvos/documentation/DeveloperTools/Conceptual/InstrumentsUserGuide/UIAutomation.html"/>
118118
/// </summary>
119119
/// <param name="selector">The selector to use in finding the element.</param>
120120
/// <returns></returns>
@@ -141,10 +141,10 @@ public static By AndroidUIAutomator(IUiAutomatorStatementBuilder selector) =>
141141

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

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

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

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

282282
/// <summary>
283283
/// Finds element when the Ios UIAutomation selector has the specified value.
284-
/// <see cref="https://developer.apple.com/library/tvos/documentation/DeveloperTools/Conceptual/InstrumentsUserGuide/UIAutomation.html"/>
284+
/// <see href="https://developer.apple.com/library/tvos/documentation/DeveloperTools/Conceptual/InstrumentsUserGuide/UIAutomation.html"/>
285285
/// </summary>
286286
public class ByIosUIAutomation : MobileBy
287287
{
@@ -428,7 +428,7 @@ public class ByImage : MobileBy
428428
/// <summary>
429429
/// Initializes a new instance of the <see cref="ByImage"/> class.
430430
/// </summary>
431-
/// <param name="base64Template">base64-encoded template image string.</param>
431+
/// <param name="selector">base64-encoded template image string.</param>
432432
public ByImage(string selector) : base(selector, MobileSelector.Image)
433433
{
434434
}

‎src/Appium.Net/Appium/MultiAction/MultiAction.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ public class MultiAction : IMultiAction
2626
private IPerformsTouchActions TouchActionPerformer;
2727

2828
/// <summary>
29-
/// Initializes a new instance of the <see cref="MultiTouchAction"/> class.
29+
/// Initializes a new instance of the <see cref="MultiAction"/> class.
3030
/// </summary>
31-
/// <param name="driver">The <see cref="IWebDriver"/> the driver to be used.</param>
31+
/// <param name="touchActionPerformer">The <see cref="IWebDriver"/> the driver to be used.</param>
3232
public MultiAction(IPerformsTouchActions touchActionPerformer)
3333
{
3434
this.TouchActionPerformer = touchActionPerformer;

‎src/Appium.Net/Appium/MultiAction/TouchAction.cs

+13-14
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ public TouchAction(IPerformsTouchActions touchActionPerformer)
9797
/// Press at the specified location in the element until the context menu appears.
9898
/// </summary>
9999
/// <param name="element">The target element.</param>
100-
/// <param name=x>The x coordinate relative to the element.</param>
101-
/// <param name=y>The y coordinate relative to the element.</param>
100+
/// <param name="x">The x coordinate relative to the element.</param>
101+
/// <param name="y">The y coordinate relative to the element.</param>
102102
/// <returns>A self-reference to this <see cref="ITouchAction"/>.</returns>
103103
public ITouchAction LongPress(IWebElement element, double? x = null, double? y = null)
104104
{
@@ -112,11 +112,10 @@ public ITouchAction LongPress(IWebElement element, double? x = null, double? y =
112112
}
113113

114114
/// <summary>
115-
/// Press at the specified location in the element until the context menu appears.
115+
/// Long press at the specified location described by the coordinates.
116116
/// </summary>
117-
/// <param name="element">The target element.</param>
118-
/// <param name=x>The x coordinate relative to the element.</param>
119-
/// <param name=y>The y coordinate relative to the element.</param>
117+
/// <param name="x">The x absolute coordinate.</param>
118+
/// <param name="y">The y absolute coordinate.</param>
120119
/// <returns>A self-reference to this <see cref="ITouchAction"/>.</returns>
121120
public ITouchAction LongPress(double x, double y)
122121
{
@@ -132,8 +131,8 @@ public ITouchAction LongPress(double x, double y)
132131
/// Move to the specified location in the element.
133132
/// </summary>
134133
/// <param name="element">The target element.</param>
135-
/// <param name=x>The x coordinate relative to the element.</param>
136-
/// <param name=y>The y coordinate relative to the element.</param>
134+
/// <param name="x">The x coordinate relative to the element.</param>
135+
/// <param name="y">The y coordinate relative to the element.</param>
137136
/// <returns>A self-reference to this <see cref="ITouchAction"/>.</returns>
138137
public ITouchAction MoveTo(IWebElement element, double? x = null, double? y = null)
139138
{
@@ -149,8 +148,8 @@ public ITouchAction MoveTo(IWebElement element, double? x = null, double? y = nu
149148
/// <summary>
150149
/// Move to the specified location.
151150
/// </summary>
152-
/// <param name=x>The x coordinate.</param>
153-
/// <param name=y>The y coordinate.</param>
151+
/// <param name="x">The x coordinate.</param>
152+
/// <param name="y">The y coordinate.</param>
154153
/// <returns>A self-reference to this <see cref="ITouchAction"/>.</returns>
155154
public ITouchAction MoveTo(double x, double y)
156155
{
@@ -166,8 +165,8 @@ public ITouchAction MoveTo(double x, double y)
166165
/// Press at the specified location in the element.
167166
/// </summary>
168167
/// <param name="element">The target element.</param>
169-
/// <param name=x>The x coordinate relative to the element.</param>
170-
/// <param name=y>The y coordinate relative to the element.</param>
168+
/// <param name="x">The x coordinate relative to the element.</param>
169+
/// <param name="y">The y coordinate relative to the element.</param>
171170
/// <returns>A self-reference to this <see cref="ITouchAction"/>.</returns>
172171
public ITouchAction Press(IWebElement element, double? x = null, double? y = null)
173172
{
@@ -183,8 +182,8 @@ public ITouchAction Press(IWebElement element, double? x = null, double? y = nul
183182
/// <summary>
184183
/// Press at the specified location.
185184
/// </summary>
186-
/// <param name=x>The x coordinate.</param>
187-
/// <param name=y>The y coordinate.</param>
185+
/// <param name="x">The x coordinate.</param>
186+
/// <param name="y">The y coordinate.</param>
188187
/// <returns>A self-reference to this <see cref="ITouchAction"/>.</returns>
189188
public ITouchAction Press(double x, double y)
190189
{

‎src/Appium.Net/Appium/Service/AppiumCommandExecutor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ public Response Execute(Command commandToExecute)
6767
}
6868
return result;
6969
}
70-
catch (Exception e)
70+
catch (Exception)
7171
{
7272
HandleCommandException(commandToExecute);
7373

‎src/Appium.Net/Appium/iOS/IOSDriver.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ public IOSDriver(AppiumServiceBuilder builder, DriverOptions driverOptions, Time
8181
/// Initializes a new instance of the IOSDriver class using the specified remote address and Appium options
8282
/// </summary>
8383
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub).</param>
84-
/// <param name="DriverOptions">An <see cref="DriverOptions"/> object containing the Appium options.</param>
84+
/// <param name="driverOptions">An <see cref="DriverOptions"/> object containing the Appium options.</param>
8585
public IOSDriver(Uri remoteAddress, DriverOptions driverOptions)
8686
: base(remoteAddress, SetPlatformToCapabilities(driverOptions, Platform))
8787
{
@@ -101,7 +101,7 @@ public IOSDriver(AppiumLocalService service, DriverOptions driverOptions)
101101
/// Initializes a new instance of the IOSDriver class using the specified remote address, Appium options, and command timeout.
102102
/// </summary>
103103
/// <param name="remoteAddress">URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub).</param>
104-
/// <param name="DriverOptions">An <see cref="DriverOptions"/> object containing the Appium options.</param>
104+
/// <param name="driverOptions">An <see cref="DriverOptions"/> object containing the Appium options.</param>
105105
/// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
106106
public IOSDriver(Uri remoteAddress, DriverOptions driverOptions, TimeSpan commandTimeout)
107107
: base(remoteAddress, SetPlatformToCapabilities(driverOptions, Platform), commandTimeout)

‎test/integration/ServerTests/StartingAppLocallyTest.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ public void CheckThatServiceIsNotRunWhenTheCreatingOfANewSessionIsFailed()
149149
{
150150
driver = new IOSDriver(service, capabilities);
151151
}
152-
catch (Exception e)
152+
catch (Exception)
153153
{
154154
Assert.That(!service.IsRunning);
155155
return;

0 commit comments

Comments
 (0)
Please sign in to comment.