diff --git a/src/app/Fake.DotNet.FxCop/FxCop.fs b/src/app/Fake.DotNet.FxCop/FxCop.fs index 6f5bc42556a..96fa25a0c2f 100644 --- a/src/app/Fake.DotNet.FxCop/FxCop.fs +++ b/src/app/Fake.DotNet.FxCop/FxCop.fs @@ -1,3 +1,20 @@ +/// Contains a task to invoke the FxCop tool +/// +/// ### Sample +/// +/// Target.create "FxCop" (fun _ -> +/// Directory.ensure "./_Reports" +/// let rules = [ "-Microsoft.Design#CA1011" // maybe sometimes +/// "-Microsoft.Design#CA1062" ] // null checks, In F#! +/// !! ("**/bin/Debug/*.dll") +/// |> FxCop.run { FxCop.Params.Create() with WorkingDirectory = "." +/// UseGAC = true +/// Verbose = false +/// ReportFileName = "_Reports/FxCopReport.xml" +/// Rules = rules +/// FailOnError = FxCop.ErrorLevel.Warning +/// IgnoreGeneratedCode = true}) +/// [] module Fake.DotNet.FxCop