Turned on xml comments

Author: JakeGinnivan

ConventionTests.sln

@@ -1,10 +1,11 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 2013
-VisualStudioVersion = 12.0.20827.3
+# Visual Studio 14
+VisualStudioVersion = 14.0.22823.1
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{AF9054EE-FE89-47A4-9156-BE54A837F2F7}"
 	ProjectSection(SolutionItems) = preProject
+		appveyor.yml = appveyor.yml
 		Build.cmd = Build.cmd
 		ConventionTests.proj = ConventionTests.proj
 		README.md = README.md

TestStack.ConventionTests.Autofac/TestStack.ConventionTests.Autofac.csproj

@@ -22,6 +22,7 @@
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Debug\TestStack.ConventionTests.Autofac.xml</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
@@ -30,6 +31,7 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Release\TestStack.ConventionTests.Autofac.xml</DocumentationFile>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="Autofac">

TestStack.ConventionTests.Autofac/TestStack.ConventionTests.Autofac.nuspec

@@ -22,5 +22,6 @@
   <files>
     <file src="TestStack.ConventionTests.Autofac.dll" target="lib\net40" />
     <file src="TestStack.ConventionTests.Autofac.pdb" target="lib\net40" />
+    <file src="TestStack.ConventionTests.Autofac.xml" target="lib\net40" />
   </files>
 </package>

TestStack.ConventionTests/Convention.cs

@@ -37,6 +37,10 @@ public static void Is<TDataSource>(IConvention<TDataSource> convention, TDataSou
             Execute(convention, data, defaultProcessors, resultProcessor ?? new ConventionReportTextRenderer());
         }
 
+        /// <summary>
+        /// Verifies a convention, any exceptions are written to ApprovalTests to approve
+        /// </summary>
+        /// <example>Convention.IsWithApprovedExeptions(new SomeConvention(), Types.InAssemblyOf&lt;SomeTypeOfMine&gt;())</example>
         public static void IsWithApprovedExeptions<TDataSource>(IConvention<TDataSource> convention, TDataSource data,
             ITestResultProcessor resultProcessor = null)
             where TDataSource : IConventionData

TestStack.ConventionTests/ConventionData/Types.cs

@@ -8,14 +8,22 @@
     using System.Reflection;
 
     /// <summary>
-    ///     This is where we set what our convention is all about.
+    ///  ConventionTests data source of Types
     /// </summary>
     public class Types : IConventionData, IEnumerable<Type>
     {
+        /// <summary>
+        /// Create an empty Types data source.
+        /// NOTE: There are static helper methods on this type. i.e Types.InAssemblyOf&lt;Foo&gt;()
+        /// </summary>
         public Types(string descriptionOfTypes) : this(Enumerable.Empty<Type>(), descriptionOfTypes)
         {
         }
 
+        /// <summary>
+        /// Create a Types data source.
+        /// NOTE: There are static helper methods on this type. i.e Types.InAssemblyOf&lt;Foo&gt;()
+        /// </summary>
         public Types(IEnumerable<Type> types, string descriptionOfTypes)
         {
             TypesToVerify = types.ToArray();
@@ -187,21 +195,21 @@ public static Types InAssembly(Assembly assembly, string descriptionOfTypes, boo
         }
 
         /// <summary>
-        /// Gets an optionally filtered list of types from the specified <param name="assemblies" />.
+        /// Creates a Types data source which includes all types from the specified assemblies
         /// </summary>
         /// <param name="assemblies">A list of assemblies to get types from.</param>
-        /// <param name="descriptionOfTypes">A description of the matched types.</param>
+        /// <param name="descriptionOfTypes">A description of the types.</param>
         /// <param name="excludeCompilerGeneratedTypes">Compiler generated types will be excluded if set to <c>true</c>.</param>
         public static Types InAssemblies(IEnumerable<Assembly> assemblies, string descriptionOfTypes, bool excludeCompilerGeneratedTypes = true)
         {
             return InAssemblies(assemblies, descriptionOfTypes, type => !(excludeCompilerGeneratedTypes && type.IsCompilerGenerated()));
         }
 
         /// <summary>
-        /// Gets a list of types from the specified <param name="types" /> collection.
+        /// Creates a Types data source from an existing list of types
         /// </summary>
         /// <param name="types">The types.</param>
-        /// <param name="descriptionOfTypes">A description of the matched types.</param>
+        /// <param name="descriptionOfTypes">A description of the types.</param>
         public static Types InCollection(IEnumerable<Type> types, string descriptionOfTypes)
         {
             return new Types(types, descriptionOfTypes);

TestStack.ConventionTests/TestStack.ConventionTests.csproj

@@ -21,7 +21,8 @@
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
-    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <TreatWarningsAsErrors>false</TreatWarningsAsErrors>
+    <DocumentationFile>bin\Debug\TestStack.ConventionTests.xml</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
@@ -30,7 +31,8 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
-    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <TreatWarningsAsErrors>false</TreatWarningsAsErrors>
+    <DocumentationFile>bin\Release\TestStack.ConventionTests.xml</DocumentationFile>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="ApprovalTests">

TestStack.ConventionTests/TestStack.ConventionTests.nuspec

@@ -22,5 +22,6 @@
   <files>
     <file src="TestStack.ConventionTests.dll" target="lib\net40" />
     <file src="TestStack.ConventionTests.pdb" target="lib\net40" />
+    <file src="TestStack.ConventionTests.xml" target="lib\net40" />
   </files>
 </package>