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

chore: Fix XML comments in MobileBy.cs #752

Merged
merged 1 commit into from
Mar 4, 2024
Merged

chore: Fix XML comments in MobileBy.cs #752

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
40 changes: 20 additions & 20 deletions src/Appium.Net/Appium/MobileBy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,58 +63,58 @@ public override ReadOnlyCollection<IWebElement> FindElements(ISearchContext cont
}

/// <summary>
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
/// This method creates a <see cref="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"/>
/// <see href="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"/>
/// <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>
public static By AccessibilityId(string selector) => new ByAccessibilityId(selector);

/// <summary>
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
/// This method creates a <see cref="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>
public static By AndroidUIAutomator(string selector) => new ByAndroidUIAutomator(selector);

/// <summary>
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
/// This method creates a <see cref="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>
public static By AndroidUIAutomator(IUiAutomatorStatementBuilder selector) =>
new ByAndroidUIAutomator(selector);

/// <summary>
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
/// This method creates a <see cref="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>
public static By AndroidDataMatcher(string selector) => new ByAndroidDataMatcher(selector);

/// <summary>
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
/// This method creates a <see cref="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>
public static By AndroidViewMatcher(string selector) => new ByAndroidViewMatcher(selector);

/// <summary>
/// This method creates a <see cref="OpenQA.Selenium.By"/> strategy
/// This method creates a <see cref="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 Down Expand Up @@ -142,9 +142,9 @@ 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"/>
/// <see href="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"/>
/// <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">Image selector.</param>
public ByImage(string selector) : base(selector, MobileSelector.Image)
{
}
Expand Down