Merge pull request #7 from NLog/xmldoc

Added XML docs
NLog · Jan 4, 2016 · ac7d476 · ac7d476
2 parents 0e65600 + b649038
commit ac7d476
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/NLog.ManualFlush/ManualFlushWrapper.cs b/NLog.ManualFlush/ManualFlushWrapper.cs
@@ -5,16 +5,27 @@
 
 namespace NLog.ManualFlush
 {
+    /// <summary>
+    /// Wrapper target for manual controlling of flush behavior.
+    /// </summary>
 	[Target("ManualFlush")]
 	public class ManualFlushWrapper : WrapperTargetBase
 	{
 		private readonly IList<AsyncLogEventInfo> logs = new List<AsyncLogEventInfo>();
 
+        /// <summary>
+        /// Write the event.
+        /// </summary>
+        /// <param name="logEvent">Event to be written.</param>
 		protected override void Write(AsyncLogEventInfo logEvent)
 		{
 			logs.Add(logEvent);
 		}
 
+        /// <summary>
+        /// Flush and clear events.
+        /// </summary>
+        /// <param name="asyncContinuation"></param>
 		protected override void FlushAsync(AsyncContinuation asyncContinuation)
 		{
 			foreach (var log in logs)
@@ -26,6 +37,9 @@ protected override void FlushAsync(AsyncContinuation asyncContinuation)
 			base.FlushAsync(asyncContinuation);
 		}
 
+        /// <summary>
+        /// Clear the current events.
+        /// </summary>
 		public void EmptyLogs()
 		{
 			logs.Clear();

diff --git a/NLog.ManualFlush/NLog.ManualFlush.csproj b/NLog.ManualFlush/NLog.ManualFlush.csproj
@@ -20,6 +20,8 @@
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Debug\NLog.ManualFlush.XML</DocumentationFile>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
@@ -28,6 +30,8 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <DocumentationFile>bin\Release\NLog.ManualFlush.XML</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup>
     <SignAssembly>true</SignAssembly>