Skip to content

Commit 8248e3a

Browse files
committed
Add docs for DotCover.Xunit2
1 parent 2890968 commit 8248e3a

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/app/FakeLib/DotCover.fs

+12
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,18 @@ let DotCoverNUnit (setDotCoverParams: DotCoverParams -> DotCoverParams) (setNUni
180180

181181
traceEndTask "DotCoverNUnit" details
182182

183+
/// Runs the dotCover "cover" command against the XUnit2 test runner.
184+
/// ## Parameters
185+
///
186+
/// - `setDotCoverParams` - Function used to overwrite the dotCover report default parameters.
187+
/// - `setXUnit2Params` - Function used to overwrite the XUnit2 default parameters.
188+
///
189+
/// ## Sample
190+
///
191+
/// !! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll")
192+
/// |> DotCoverXUnit2
193+
/// (fun -> dotCoverOptions )
194+
/// (fun nUnitOptions -> nUnitOptions)
183195
let DotCoverXUnit2 (setDotCoverParams: DotCoverParams -> DotCoverParams) (setXUnit2Params: XUnit2Params -> XUnit2Params) (assemblies: string seq) =
184196
let assemblies = assemblies |> Seq.toArray
185197
let details = assemblies |> separated ", "

0 commit comments

Comments
 (0)