From 2520ae160acabd3097e6284c768b55c6c9d3b489 Mon Sep 17 00:00:00 2001
From: Steven Kirk <grokys@gmail.com>
Date: Fri, 28 Aug 2015 14:55:23 +0200
Subject: [PATCH] Added StyleCop.Analyzers to Perspex.Markup,Xaml.

---
 .../Perspex.Markup.Xaml/GlobalSuppressions.cs | 14 +++++++
 .../Perspex.Markup.Xaml.csproj                |  5 +++
 .../Perspex.Markup.Xaml/PerspexXamlLoader.cs  | 37 ++++++++++++++++++-
 .../Perspex.Markup.Xaml/packages.config       |  1 +
 4 files changed, 56 insertions(+), 1 deletion(-)
 create mode 100644 src/Markup/Perspex.Markup.Xaml/GlobalSuppressions.cs

diff --git a/src/Markup/Perspex.Markup.Xaml/GlobalSuppressions.cs b/src/Markup/Perspex.Markup.Xaml/GlobalSuppressions.cs
new file mode 100644
index 0000000000..3d080850f1
--- /dev/null
+++ b/src/Markup/Perspex.Markup.Xaml/GlobalSuppressions.cs
@@ -0,0 +1,14 @@
+// -----------------------------------------------------------------------
+// <copyright file="GlobalSuppressions.cs" company="Steven Kirk">
+// Copyright 2015 MIT Licence. See licence.md for more information.
+// </copyright>
+// -----------------------------------------------------------------------
+
+[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage(
+    "StyleCop.CSharp.MaintainabilityRules",
+    "SA1401:Fields must be private",
+    Justification = "PerspexProperty fields should not be private.")]
+[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage(
+    "StyleCop.CSharp.DocumentationRules",
+    "SA1609:Property documentation must have value",
+    Justification = "This rule is fscking pointless")]
\ No newline at end of file
diff --git a/src/Markup/Perspex.Markup.Xaml/Perspex.Markup.Xaml.csproj b/src/Markup/Perspex.Markup.Xaml/Perspex.Markup.Xaml.csproj
index 5d7d97e26d..b1dfe8478d 100644
--- a/src/Markup/Perspex.Markup.Xaml/Perspex.Markup.Xaml.csproj
+++ b/src/Markup/Perspex.Markup.Xaml/Perspex.Markup.Xaml.csproj
@@ -32,6 +32,7 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Release\Perspex.Markup.Xaml.XML</DocumentationFile>
   </PropertyGroup>
   <ItemGroup>
     <Compile Include="..\..\Shared\SharedAssemblyInfo.cs">
@@ -39,6 +40,7 @@
     </Compile>
     <Compile Include="Converters\ThicknessConverter.cs" />
     <Compile Include="Context\PerspexWiringContext.cs" />
+    <Compile Include="GlobalSuppressions.cs" />
     <Compile Include="MarkupExtensions\BindingExtension.cs" />
     <Compile Include="Converters\BrushConverter.cs" />
     <Compile Include="Converters\BitmapConverter.cs" />
@@ -152,6 +154,9 @@
       <Private>True</Private>
     </Reference>
   </ItemGroup>
+  <ItemGroup>
+    <Analyzer Include="..\..\..\packages\StyleCop.Analyzers.1.0.0-beta008\analyzers\dotnet\cs\StyleCop.Analyzers.dll" />
+  </ItemGroup>
   <Import Project="$(MSBuildExtensionsPath32)\Microsoft\Portable\$(TargetFrameworkVersion)\Microsoft.Portable.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
        Other similar extension points exist, see Microsoft.Common.targets.
diff --git a/src/Markup/Perspex.Markup.Xaml/PerspexXamlLoader.cs b/src/Markup/Perspex.Markup.Xaml/PerspexXamlLoader.cs
index 12aed169b9..6c81c82b23 100644
--- a/src/Markup/Perspex.Markup.Xaml/PerspexXamlLoader.cs
+++ b/src/Markup/Perspex.Markup.Xaml/PerspexXamlLoader.cs
@@ -1,6 +1,6 @@
 // -----------------------------------------------------------------------
 // <copyright file="PerspexXamlLoader.cs" company="Steven Kirk">
-// Copyright 2014 MIT Licence. See licence.md for more information.
+// Copyright 2015 MIT Licence. See licence.md for more information.
 // </copyright>
 // -----------------------------------------------------------------------
 
@@ -13,29 +13,59 @@ namespace Perspex.Markup.Xaml
     using Platform;
     using Splat;
 
+    /// <summary>
+    /// Loads XAML for a perspex application.
+    /// </summary>
     public class PerspexXamlLoader : XamlLoader
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="PerspexXamlLoader"/> class.
+        /// </summary>
         public PerspexXamlLoader()
             : this(new PerspexParserFactory())
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="PerspexXamlLoader"/> class.
+        /// </summary>
+        /// <param name="xamlParserFactory">The parser factory to use.</param>
         public PerspexXamlLoader(IXamlParserFactory xamlParserFactory)
             : base(xamlParserFactory)
         {
         }
 
+        /// <summary>
+        /// Loads the XAML into a Perspex component.
+        /// </summary>
+        /// <param name="obj">The object to load the XAML into.</param>
         public static void Load(object obj)
         {
             var loader = new PerspexXamlLoader();
             loader.Load(obj.GetType(), obj);
         }
 
+        /// <summary>
+        /// Loads the XAML for a type.
+        /// </summary>
+        /// <param name="type">The type.</param>
+        /// <param name="rootInstance">
+        /// The optional instance into which the XAML should be loaded.
+        /// </param>
+        /// <returns>The loaded object.</returns>
         public object Load(Type type, object rootInstance = null)
         {
             return this.Load(GetUriFor(type), rootInstance);
         }
 
+        /// <summary>
+        /// Loads XAML from a URI.
+        /// </summary>
+        /// <param name="uri">The URI of the XAML file.</param>
+        /// <param name="rootInstance">
+        /// The optional instance into which the XAML should be loaded.
+        /// </param>
+        /// <returns>The loaded object.</returns>
         public object Load(Uri uri, object rootInstance = null)
         {
             var assetLocator = Locator.Current.GetService<IAssetLoader>();
@@ -52,6 +82,11 @@ namespace Perspex.Markup.Xaml
             }
         }
 
+        /// <summary>
+        /// Gets the URI for a type.
+        /// </summary>
+        /// <param name="type">The type.</param>
+        /// <returns>The URI.</returns>
         private static Uri GetUriFor(Type type)
         {
             if (type.Namespace != null)
diff --git a/src/Markup/Perspex.Markup.Xaml/packages.config b/src/Markup/Perspex.Markup.Xaml/packages.config
index ec6f65c7eb..df1209b075 100644
--- a/src/Markup/Perspex.Markup.Xaml/packages.config
+++ b/src/Markup/Perspex.Markup.Xaml/packages.config
@@ -13,4 +13,5 @@
   <package id="Splat" version="1.6.2" targetFramework="portable46-net451+win81" />
   <package id="Sprache" version="2.0.0.46" targetFramework="portable46-net451+win81" />
   <package id="Sprache.SuperJMN" version="2.0.0.46" targetFramework="portable46-net451+win81" />
+  <package id="StyleCop.Analyzers" version="1.0.0-beta008" targetFramework="portable46-net451+win81" developmentDependency="true" />
 </packages>
\ No newline at end of file