Fixed some xml doc warnings

This commit is contained in:
Ami Bar
2012-08-22 00:23:36 +03:00
parent e1f484c914
commit 7cb0bedd6c
5 changed files with 13 additions and 18 deletions
+1 -3
View File
@@ -8,7 +8,5 @@ using System.Reflection;
[assembly: AssemblyCopyright("")] [assembly: AssemblyCopyright("")]
[assembly: AssemblyTrademark("")] [assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")] [assembly: AssemblyCulture("")]
[assembly: AssemblyVersion("1.0.*")] [assembly: AssemblyVersion("1.0.0.0")]
[assembly: AssemblyDelaySign(false)] [assembly: AssemblyDelaySign(false)]
[assembly: AssemblyKeyFile("")]
[assembly: AssemblyKeyName("")]
+8 -8
View File
@@ -328,35 +328,35 @@ namespace Amib.Threading
/// <summary> /// <summary>
/// Queue a work item. /// Queue a work item.
/// </summary> /// </summary>
/// <returns>Returns a IWorkItemResult<TResult> object. /// <returns>Returns a IWorkItemResult&lt;TResult&gt; object.
/// its GetResult() returns a TResult object</returns> /// its GetResult() returns a TResult object</returns>
IWorkItemResult<TResult> QueueWorkItem<TResult>(Func<TResult> func); IWorkItemResult<TResult> QueueWorkItem<TResult>(Func<TResult> func);
/// <summary> /// <summary>
/// Queue a work item. /// Queue a work item.
/// </summary> /// </summary>
/// <returns>Returns a IWorkItemResult<TResult> object. /// <returns>Returns a IWorkItemResult&lt;TResult&gt; object.
/// its GetResult() returns a TResult object</returns> /// its GetResult() returns a TResult object</returns>
IWorkItemResult<TResult> QueueWorkItem<T, TResult>(Func<T, TResult> func, T arg); IWorkItemResult<TResult> QueueWorkItem<T, TResult>(Func<T, TResult> func, T arg);
/// <summary> /// <summary>
/// Queue a work item. /// Queue a work item.
/// </summary> /// </summary>
/// <returns>Returns a IWorkItemResult<TResult> object. /// <returns>Returns a IWorkItemResult&lt;TResult&gt; object.
/// its GetResult() returns a TResult object</returns> /// its GetResult() returns a TResult object</returns>
IWorkItemResult<TResult> QueueWorkItem<T1, T2, TResult>(Func<T1, T2, TResult> func, T1 arg1, T2 arg2); IWorkItemResult<TResult> QueueWorkItem<T1, T2, TResult>(Func<T1, T2, TResult> func, T1 arg1, T2 arg2);
/// <summary> /// <summary>
/// Queue a work item. /// Queue a work item.
/// </summary> /// </summary>
/// <returns>Returns a IWorkItemResult<TResult> object. /// <returns>Returns a IWorkItemResult&lt;TResult&gt; object.
/// its GetResult() returns a TResult object</returns> /// its GetResult() returns a TResult object</returns>
IWorkItemResult<TResult> QueueWorkItem<T1, T2, T3, TResult>(Func<T1, T2, T3, TResult> func, T1 arg1, T2 arg2, T3 arg3); IWorkItemResult<TResult> QueueWorkItem<T1, T2, T3, TResult>(Func<T1, T2, T3, TResult> func, T1 arg1, T2 arg2, T3 arg3);
/// <summary> /// <summary>
/// Queue a work item. /// Queue a work item.
/// </summary> /// </summary>
/// <returns>Returns a IWorkItemResult<TResult> object. /// <returns>Returns a IWorkItemResult&lt;TResult&gt; object.
/// its GetResult() returns a TResult object</returns> /// its GetResult() returns a TResult object</returns>
IWorkItemResult<TResult> QueueWorkItem<T1, T2, T3, T4, TResult>(Func<T1, T2, T3, T4, TResult> func, T1 arg1, T2 arg2, T3 arg3, T4 arg4); IWorkItemResult<TResult> QueueWorkItem<T1, T2, T3, T4, TResult>(Func<T1, T2, T3, T4, TResult> func, T1 arg1, T2 arg2, T3 arg3, T4 arg4);
@@ -396,7 +396,7 @@ namespace Amib.Threading
#region IWorkItemResult interface #region IWorkItemResult interface
/// <summary> /// <summary>
/// The common interface of IWorkItemResult and IWorkItemResult<T> /// The common interface of IWorkItemResult and IWorkItemResult&lt;T&gt;
/// </summary> /// </summary>
public interface IWaitableResult public interface IWaitableResult
{ {
@@ -422,8 +422,8 @@ namespace Amib.Threading
} }
/// <summary> /// <summary>
/// IWorkItemResult<TResult> interface. /// IWorkItemResult&lt;TResult&gt; interface.
/// Created when a Func<T> work item is queued. /// Created when a Func&lt;TResult&gt; work item is queued.
/// </summary> /// </summary>
public interface IWorkItemResult<TResult> : IWaitableResult public interface IWorkItemResult<TResult> : IWaitableResult
{ {
+1 -6
View File
@@ -182,7 +182,7 @@ namespace Amib.Threading
/// <summary> /// <summary>
/// The default fill state with params. (false) /// The default fill state with params. (false)
/// It is relevant only to QueueWorkItem of Action<...>/Func<...> /// It is relevant only to QueueWorkItem of Action&lt;...&gt;/Func&lt;...&gt;
/// </summary> /// </summary>
public const bool DefaultFillStateWithArgs = false; public const bool DefaultFillStateWithArgs = false;
@@ -271,11 +271,6 @@ namespace Amib.Threading
/// </summary> /// </summary>
private bool _isDisposed; private bool _isDisposed;
/// <summary>
/// On idle event
/// </summary>
//private event WorkItemsGroupIdleHandler _onIdle;
/// <summary> /// <summary>
/// Holds all the WorkItemsGroup instaces that have at least one /// Holds all the WorkItemsGroup instaces that have at least one
/// work item int the SmartThreadPool /// work item int the SmartThreadPool
+2
View File
@@ -23,12 +23,14 @@
<DefineConstants>TRACE;DEBUG;_WINDOWS</DefineConstants> <DefineConstants>TRACE;DEBUG;_WINDOWS</DefineConstants>
<DocumentationFile> <DocumentationFile>
</DocumentationFile> </DocumentationFile>
<NoWarn>1591</NoWarn>
</PropertyGroup> </PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' "> <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
<DebugType>pdbonly</DebugType> <DebugType>pdbonly</DebugType>
<Optimize>true</Optimize> <Optimize>true</Optimize>
<OutputPath>.\bin\Release\</OutputPath> <OutputPath>.\bin\Release\</OutputPath>
<DefineConstants>TRACE;_WINDOWS</DefineConstants> <DefineConstants>TRACE;_WINDOWS</DefineConstants>
<NoWarn>1591</NoWarn>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<Reference Include="System" /> <Reference Include="System" />
+1 -1
View File
@@ -145,7 +145,7 @@ namespace Amib.Threading
} }
/// <summary> /// <summary>
/// Get/Set the if QueueWorkItem of Action<...>/Func<...> fill the /// Get/Set the if QueueWorkItem of Action&lt;...&gt;/Func&lt;...&gt; fill the
/// arguments as an object array into the state of the work item. /// arguments as an object array into the state of the work item.
/// The arguments can be access later by IWorkItemResult.State. /// The arguments can be access later by IWorkItemResult.State.
/// </summary> /// </summary>