chore: Fix Rotate XML documentation (#707)

appium · Dec 11, 2023 · d07b741 · d07b741
1 parent b8e1aa3
commit d07b741
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 8 deletions.
diff --git a/src/Appium.Net/Appium/AppiumDriver.cs b/src/Appium.Net/Appium/AppiumDriver.cs
@@ -136,11 +136,20 @@ Response IExecuteMethod.Execute(string commandName, Dictionary<string, object> p
         #region MJsonMethod Members
 
         /// <summary>
-        /// Rotates Device.
+        /// Rotates the device.
         /// </summary>
-        /// <param name="opts">rotations options like the following:
-        /// new Dictionary<string, int> {{"x", 114}, {"y", 198}, {"duration", 5}, 
-        /// {"radius", 3}, {"rotation", 220}, {"touchCount", 2}}
+        /// <param name="opts">
+        /// Rotations options like the following:
+        /// <example>
+        /// new Dictionary&lt;string, int&gt; {
+        ///     {"x", 114},
+        ///     {"y", 198},
+        ///     {"duration", 5},
+        ///     {"radius", 3},
+        ///     {"rotation", 220},
+        ///     {"touchCount", 2}
+        /// }
+        /// </example>
         /// </param>
         public void Rotate(Dictionary<string, int> opts)
         {

diff --git a/src/Appium.Net/Appium/AppiumElement.cs b/src/Appium.Net/Appium/AppiumElement.cs
@@ -181,11 +181,20 @@ protected virtual object CacheValue(string key, Func<object> getter)
         #region MJSonMethods
 
         /// <summary>
-        /// Rotates Device.
+        /// Rotates the device.
         /// </summary>
-        /// <param name="opts">rotations options like the following:
-        /// new Dictionary<string, int> {{"x", 114}, {"y", 198}, {"duration", 5}, 
-        /// {"radius", 3}, {"rotation", 220}, {"touchCount", 2}}
+        /// <param name="opts">
+        /// Rotations options like the following:
+        /// <example>
+        /// new Dictionary&lt;string, int&gt; {
+        ///     {"x", 114},
+        ///     {"y", 198},
+        ///     {"duration", 5},
+        ///     {"radius", 3},
+        ///     {"rotation", 220},
+        ///     {"touchCount", 2}
+        /// }
+        /// </example>
         /// </param>
         public void Rotate(Dictionary<string, int> opts)
         {