Some lesser XML documentation improvements

git-svn-id: file:///srv/devel/repo-conversion/nusu@44 d2e56fa2-650e-0410-a79f-9358c0239efd
This commit is contained in:
Markus Ewald 2007-08-31 21:24:40 +00:00
parent caeee49f4a
commit 4b0d3d26cc
2 changed files with 9 additions and 6 deletions

View File

@ -28,7 +28,8 @@ namespace Nuclex.Support.Scheduling {
public class ThreadCallbackOperation : ThreadOperation { public class ThreadCallbackOperation : ThreadOperation {
/// <summary> /// <summary>
/// Initializes a new threaded method operation for a parameterless method /// Initializes a new threaded method operation that will call back a
/// parameterless method from the background thread.
/// </summary> /// </summary>
/// <param name="method">Method to be invoked in a background thread</param> /// <param name="method">Method to be invoked in a background thread</param>
/// <remarks> /// <remarks>
@ -38,7 +39,9 @@ namespace Nuclex.Support.Scheduling {
: this(method, true) { } : this(method, true) { }
/// <summary> /// <summary>
/// Initializes a new threaded method operation for a parameterless method /// Initializes a new threaded method operation that will call back a
/// parameterless method from the background thread and use the
/// thread pool optionally.
/// </summary> /// </summary>
/// <param name="method">Method to be invoked in a background thread</param> /// <param name="method">Method to be invoked in a background thread</param>
/// <param name="useThreadPool">Whether to use a ThreadPool thread</param> /// <param name="useThreadPool">Whether to use a ThreadPool thread</param>

View File

@ -28,17 +28,17 @@ namespace Nuclex.Support.Scheduling {
public abstract class ThreadOperation : Operation { public abstract class ThreadOperation : Operation {
/// <summary> /// <summary>
/// Initializes a new threaded operation /// Initializes a new threaded operation.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Uses a ThreadPool thread to execute the method in /// Uses a ThreadPool thread to execute the method in a background thread.
/// </remarks> /// </remarks>
public ThreadOperation() : this(true) { } public ThreadOperation() : this(true) { }
/// <summary> /// <summary>
/// Initializes a new threaded operation /// Initializes a new threaded operation which optionally uses the ThreadPool.
/// </summary> /// </summary>
/// <param name="useThreadPool">Whether tos use a ThreadPool thread</param> /// <param name="useThreadPool">Whether to use a ThreadPool thread.</param>
/// <remarks> /// <remarks>
/// If useThreadPool is false, a new thread will be created. This guarantees /// If useThreadPool is false, a new thread will be created. This guarantees
/// that the method will be executed immediately but has an impact on /// that the method will be executed immediately but has an impact on