Skip to content

Commit 5e8a09c

Browse files
authored
Refactor parameter names and update documentation (#901)
Refactored parameter names across multiple interfaces for clarity: - `IPushesFiles.PushFile`: `base64Data` to `stringData` and `file` - `IFindsByFluentSelector.FindElements`: `by` to `selector` - `IInteractsWithApps`: `appPath` to `bundleId` and `appId` - `ITouchAction.LongPress`: `el` to `element` Updated documentation comments for better compatibility: - `INetworkActions.ToggleData`: `<=` to `&lt;=` - Removed empty `<param>` tag in `INetworkActions.SetGsmSignalStrength`
1 parent 66a1c5f commit 5e8a09c

File tree

5 files changed

+8
-10
lines changed

5 files changed

+8
-10
lines changed

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/Interfaces/IFindsByFluentSelector.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public interface IFindsByFluentSelector<out W> where W : IWebElement
3131
/// Method performs the searching for a list of elements by some selector defined by string
3232
/// and value of the given selector
3333
/// </summary>
34-
/// <param name="by">is a string selector</param>
34+
/// <param name="selector">is a string selector</param>
3535
/// <param name="value">is a value of the given selector</param>
3636
/// <returns>a list of elements</returns>
3737
IReadOnlyCollection<W> FindElements(string selector, string value);

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

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

@@ -46,13 +46,13 @@ public interface IInteractsWithApps : IExecuteMethod
4646
/// <summary>
4747
/// Removes an App.
4848
/// </summary>
49-
/// <param name="appPath">a string containing the id of the app.</param>
49+
/// <param name="appId">a string containing the id of the app.</param>
5050
void RemoveApp(string appId);
5151

5252
/// <summary>
5353
/// 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.
5454
/// </summary>
55-
/// <param name="appPath">a string containing the id of the app.</param>
55+
/// <param name="appId">a string containing the id of the app.</param>
5656
void ActivateApp(string appId);
5757

5858
/// <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

+1-2
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,11 @@ public interface ITouchAction
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>
3131
/// Press at the specified location until the context menu appears.
3232
/// </summary>
33-
/// <param name="element">The target element.</param>
3433
/// <param name="x">The x coordinate relative to the element.</param>
3534
/// <param name="y">The y coordinate relative to the element.</param>
3635
/// <returns>A self-reference to this <see cref="ITouchAction"/>.</returns>

0 commit comments

Comments
 (0)