瀏覽代碼

Merge pull request #7108 from workgroupengineering/fixes/XML_Documentation_2

fixes(IDispatcher): Methods XML Documentation
Max Katz 4 年之前
父節點
當前提交
75ddc9d592
共有 1 個文件被更改,包括 6 次插入5 次删除
  1. 6 5
      src/Avalonia.Base/Threading/IDispatcher.cs

+ 6 - 5
src/Avalonia.Base/Threading/IDispatcher.cs

@@ -20,25 +20,26 @@ namespace Avalonia.Threading
         void VerifyAccess();
         void VerifyAccess();
 
 
         /// <summary>
         /// <summary>
-        /// Invokes a method on the dispatcher thread.
+        /// Posts an action that will be invoked on the dispatcher thread.
         /// </summary>
         /// </summary>
         /// <param name="action">The method.</param>
         /// <param name="action">The method.</param>
         /// <param name="priority">The priority with which to invoke the method.</param>
         /// <param name="priority">The priority with which to invoke the method.</param>
-        /// <returns>A task that can be used to track the method's execution.</returns>
         void Post(Action action, DispatcherPriority priority = DispatcherPriority.Normal);
         void Post(Action action, DispatcherPriority priority = DispatcherPriority.Normal);
 
 
         /// <summary>
         /// <summary>
-        /// Posts an action that will be invoked on the dispatcher thread.
+        /// Invokes a action on the dispatcher thread.
         /// </summary>
         /// </summary>
         /// <param name="action">The method.</param>
         /// <param name="action">The method.</param>
         /// <param name="priority">The priority with which to invoke the method.</param>
         /// <param name="priority">The priority with which to invoke the method.</param>
+        /// <returns>A task that can be used to track the method's execution.</returns>
         Task InvokeAsync(Action action, DispatcherPriority priority = DispatcherPriority.Normal);
         Task InvokeAsync(Action action, DispatcherPriority priority = DispatcherPriority.Normal);
 
 
         /// <summary>
         /// <summary>
-        /// Posts a function that will be invoked on the dispatcher thread.
+        /// Invokes a method on the dispatcher thread.
         /// </summary>
         /// </summary>
         /// <param name="function">The method.</param>
         /// <param name="function">The method.</param>
         /// <param name="priority">The priority with which to invoke the method.</param>
         /// <param name="priority">The priority with which to invoke the method.</param>
+        /// <returns>A task that can be used to track the method's execution.</returns>
         Task<TResult> InvokeAsync<TResult>(Func<TResult> function, DispatcherPriority priority = DispatcherPriority.Normal);
         Task<TResult> InvokeAsync<TResult>(Func<TResult> function, DispatcherPriority priority = DispatcherPriority.Normal);
 
 
         /// <summary>
         /// <summary>
@@ -59,4 +60,4 @@ namespace Avalonia.Threading
         /// <returns>A task that represents a proxy for the task returned by <paramref name="function"/>.</returns>
         /// <returns>A task that represents a proxy for the task returned by <paramref name="function"/>.</returns>
         Task<TResult> InvokeAsync<TResult>(Func<Task<TResult>> function, DispatcherPriority priority = DispatcherPriority.Normal);
         Task<TResult> InvokeAsync<TResult>(Func<Task<TResult>> function, DispatcherPriority priority = DispatcherPriority.Normal);
     }
     }
-}
+}