Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SteveGilham committed Mar 14, 2024
1 parent 3666624 commit 0361473
Show file tree
Hide file tree
Showing 28 changed files with 248 additions and 114 deletions.
3 changes: 2 additions & 1 deletion docs/AltCover.Cake/AltCover.Cake/PrepareOptions-apidoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ public class PrepareOptions
| virtual [MethodPoint](PrepareOptions/MethodPoint-apidoc) { get; } | Corresponds to command line option `--methodpoint` |
| virtual [MethodTopLevel](PrepareOptions/MethodTopLevel-apidoc) { get; } | Corresponds to command line option `--methodtoplevel=VALUE` |
| [OutputDirectories](PrepareOptions/OutputDirectories-apidoc) { get; } | Gets the output directories (overridden by the MSBuild integration) |
| virtual [OutputRoot](PrepareOptions/OutputRoot-apidoc) { get; } | Corresponds to dotnet test option `/p:AltCoverOutputRoot` |
| virtual [PathFilter](PrepareOptions/PathFilter-apidoc) { get; } | Corresponds to command line option `-p, --pathFilter=VALUE` |
| virtual [Report](PrepareOptions/Report-apidoc) { get; } | Gets or sets the value that corresponds to command line option `-r, --report=VALUE` |
| virtual [ReportFormat](PrepareOptions/ReportFormat-apidoc) { get; } | Corresponds to command line option `--reportFormat=VALUE` |
Expand All @@ -41,7 +42,7 @@ public class PrepareOptions
| virtual [SourceLink](PrepareOptions/SourceLink-apidoc) { get; } | Corresponds to command line option `--sourcelink` |
| virtual [StrongNameKey](PrepareOptions/StrongNameKey-apidoc) { get; } | Corresponds to command line option `--sn, --strongNameKey=VALUE` |
| virtual [SymbolDirectories](PrepareOptions/SymbolDirectories-apidoc) { get; } | Corresponds to command line option `-y, --symbolDirectory=VALUE` |
| virtual [Trivia](PrepareOptions/Trivia-apidoc) { get; } | Corresponds to command line option ` --trivia` |
| virtual [Trivia](PrepareOptions/Trivia-apidoc) { get; } | Corresponds to command line option `--trivia` |
| virtual [TypeFilter](PrepareOptions/TypeFilter-apidoc) { get; } | Corresponds to command line option `-t, --typeFilter=VALUE` |
| virtual [TypeTopLevel](PrepareOptions/TypeTopLevel-apidoc) { get; } | Corresponds to command line option `--typetoplevel=VALUE` |
| virtual [Verbosity](PrepareOptions/Verbosity-apidoc) { get; } | Corresponds to command line option `-q` |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# PrepareOptions.OutputRoot property

Corresponds to dotnet test option `/p:AltCoverOutputRoot`

```csharp
public virtual string OutputRoot { get; }
```

## See Also

* class [PrepareOptions](../PrepareOptions-apidoc)
* namespace [AltCover.Cake](../../AltCover.Cake-apidoc)

<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Cake.dll -->
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PrepareOptions.Trivia property

Corresponds to command line option ` --trivia`
Corresponds to command line option `--trivia`

```csharp
public virtual bool Trivia { get; }
Expand Down
1 change: 1 addition & 0 deletions docs/AltCover.DotNet/AltCover/Options.Prepare-apidoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ public class Prepare
| [MethodPoint](Options.Prepare/MethodPoint-apidoc) { getset; } | |
| [MethodTopLevel](Options.Prepare/MethodTopLevel-apidoc) { getset; } | |
| [OutputDirectories](Options.Prepare/OutputDirectories-apidoc) { getset; } | |
| [OutputRoot](Options.Prepare/OutputRoot-apidoc) { getset; } | |
| [PathFilter](Options.Prepare/PathFilter-apidoc) { getset; } | |
| [Report](Options.Prepare/Report-apidoc) { getset; } | |
| [ReportFormat](Options.Prepare/ReportFormat-apidoc) { getset; } | |
Expand Down
12 changes: 12 additions & 0 deletions docs/AltCover.DotNet/AltCover/Options.Prepare/OutputRoot-apidoc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Options.Prepare.OutputRoot property

```csharp
public string OutputRoot { get; set; }
```

## See Also

* class [Prepare](../Options.Prepare-apidoc)
* namespace [AltCover](../../AltCover.DotNet-apidoc)

<!-- DO NOT EDIT: generated by xmldocmd for AltCover.DotNet.dll -->
1 change: 1 addition & 0 deletions docs/AltCover.Engine/Abstract-fsapidoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ The members correspond to the like-named command line options for `AltCover`, ex
abstract member ShowGenerated : bool with get
abstract member Verbosity : System.Diagnostics.TraceLevel with get
abstract member Trivia : bool with get
abstract member OutputRoot : string with get
```

### interface `ILoggingOptions`
Expand Down
1 change: 1 addition & 0 deletions docs/AltCover.Engine/AltCover-fsapidoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ The members correspond to the like-named command line options for `AltCover`, ex
member ShowGenerated : bool
member Verbosity : System.Diagnostics.TraceLevel
member Trivia: bool with get
member OutputRoot : string with get
```

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ public interface IPrepareOptions
| [MethodPoint](Abstract.IPrepareOptions/MethodPoint-apidoc) { get; } | Corresponds to command line option `--methodpoint` |
| [MethodTopLevel](Abstract.IPrepareOptions/MethodTopLevel-apidoc) { get; } | Corresponds to command line option `--methodtoplevel=VALUE` |
| [OutputDirectories](Abstract.IPrepareOptions/OutputDirectories-apidoc) { get; } | Corresponds to command line option `-o, --outputDirectory=VALUE` |
| [OutputRoot](Abstract.IPrepareOptions/OutputRoot-apidoc) { get; } | Corresponds to dotnet test option `/p:AltCoverOutputRoot` |
| [PathFilter](Abstract.IPrepareOptions/PathFilter-apidoc) { get; } | Corresponds to command line option `-p, --pathFilter=VALUE` |
| [Report](Abstract.IPrepareOptions/Report-apidoc) { get; } | Corresponds to command line option `-r, --report=VALUE` |
| [ReportFormat](Abstract.IPrepareOptions/ReportFormat-apidoc) { get; } | Corresponds to command line option `--reportFormat=VALUE` |
Expand All @@ -54,7 +55,7 @@ public interface IPrepareOptions
| [SourceLink](Abstract.IPrepareOptions/SourceLink-apidoc) { get; } | Corresponds to command line option `--sourcelink` |
| [StrongNameKey](Abstract.IPrepareOptions/StrongNameKey-apidoc) { get; } | Corresponds to command line option `--sn, --strongNameKey=VALUE` |
| [SymbolDirectories](Abstract.IPrepareOptions/SymbolDirectories-apidoc) { get; } | Corresponds to command line option `-y, --symbolDirectory=VALUE` |
| [Trivia](Abstract.IPrepareOptions/Trivia-apidoc) { get; } | Corresponds to command line option ` --trivia` |
| [Trivia](Abstract.IPrepareOptions/Trivia-apidoc) { get; } | Corresponds to command line option `--trivia` |
| [TypeFilter](Abstract.IPrepareOptions/TypeFilter-apidoc) { get; } | Corresponds to command line option `-t, --typeFilter=VALUE` |
| [TypeTopLevel](Abstract.IPrepareOptions/TypeTopLevel-apidoc) { get; } | Corresponds to command line option `--typetoplevel=VALUE` |
| [Verbosity](Abstract.IPrepareOptions/Verbosity-apidoc) { get; } | Corresponds to command line option `-q` |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Abstract.IPrepareOptions.OutputRoot property

Corresponds to dotnet test option `/p:AltCoverOutputRoot`

```csharp
public string OutputRoot { get; }
```

## See Also

* interface [IPrepareOptions](../Abstract.IPrepareOptions-apidoc)
* namespace [AltCover](../../AltCover.Engine-apidoc)

<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Engine.dll -->
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Abstract.IPrepareOptions.Trivia property

Corresponds to command line option ` --trivia`
Corresponds to command line option `--trivia`

```csharp
public bool Trivia { get; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ public abstract class PrepareOptions : IEquatable<PrepareOptions>, IStructuralEq
| [MethodPoint](AltCover.PrepareOptions/MethodPoint-apidoc) { get; } | Corresponds to command line option `--methodpoint` |
| [MethodTopLevel](AltCover.PrepareOptions/MethodTopLevel-apidoc) { get; } | Corresponds to command line option `--methodtoplevel=VALUE` |
| [OutputDirectories](AltCover.PrepareOptions/OutputDirectories-apidoc) { get; } | Corresponds to command line option `-o, --outputDirectory=VALUE` |
| [OutputRoot](AltCover.PrepareOptions/OutputRoot-apidoc) { get; } | Corresponds to dotnet test option `/p:AltCoverOutputRoot` |
| [PathFilter](AltCover.PrepareOptions/PathFilter-apidoc) { get; } | Corresponds to command line option `-p, --pathFilter=VALUE` |
| [Report](AltCover.PrepareOptions/Report-apidoc) { get; } | Corresponds to command line option `-r, --report=VALUE` |
| [ReportFormat](AltCover.PrepareOptions/ReportFormat-apidoc) { get; } | Corresponds to command line option `--reportFormat=VALUE` |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# AltCover.PrepareOptions.OutputRoot property

Corresponds to dotnet test option `/p:AltCoverOutputRoot`

```csharp
public string OutputRoot { get; }
```

## See Also

* class [PrepareOptions](../AltCover.PrepareOptions-apidoc)
* namespace [AltCover](../../AltCover.Engine-apidoc)

<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Engine.dll -->
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ public sealed class PrepareOptions : IEquatable<PrepareOptions>, IStructuralEqua
| [MethodPoint](Primitive.PrepareOptions/MethodPoint-apidoc) { get; } | Corresponds to command line option `--methodpoint` |
| [MethodTopLevel](Primitive.PrepareOptions/MethodTopLevel-apidoc) { get; } | Corresponds to command line option `--methodtoplevel=VALUE` |
| [OutputDirectories](Primitive.PrepareOptions/OutputDirectories-apidoc) { get; } | Corresponds to command line option `-o, --outputDirectory=VALUE` |
| [OutputRoot](Primitive.PrepareOptions/OutputRoot-apidoc) { get; } | Corresponds to dotnet test option `/p:AltCoverOutputRoot` |
| [PathFilter](Primitive.PrepareOptions/PathFilter-apidoc) { get; } | Corresponds to command line option `-p, --pathFilter=VALUE` |
| [Report](Primitive.PrepareOptions/Report-apidoc) { get; } | Corresponds to command line option `-r, --report=VALUE` |
| [ReportFormat](Primitive.PrepareOptions/ReportFormat-apidoc) { get; } | Corresponds to command line option `--reportFormat=VALUE` |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Primitive.PrepareOptions.OutputRoot property

Corresponds to dotnet test option `/p:AltCoverOutputRoot`

```csharp
public string OutputRoot { get; }
```

## See Also

* class [PrepareOptions](../Primitive.PrepareOptions-apidoc)
* namespace [AltCover](../../AltCover.Engine-apidoc)

<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Engine.dll -->
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ public PrepareOptions(IEnumerable<string> inputDirectories, IEnumerable<string>
bool inPlace, bool save, bool zipFile, bool methodPoint, bool singleVisit, bool lineCover,
bool branchCover, IEnumerable<string> commandLine, bool exposeReturnCode, bool sourceLink,
bool defer, bool localSource, bool visibleBranches, string showStatic, bool showGenerated,
TraceLevel verbosity, bool trivia)
TraceLevel verbosity, bool trivia, string outputRoot)
```

## See Also
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ public sealed class PrepareOptions : IEquatable<PrepareOptions>, IStructuralEqua
| [MethodPoint](TypeSafe.PrepareOptions/MethodPoint-apidoc) { get; } | Corresponds to command line option `--methodpoint` |
| [MethodTopLevel](TypeSafe.PrepareOptions/MethodTopLevel-apidoc) { get; } | Corresponds to command line option `--methodtoplevel=VALUE` |
| [OutputDirectories](TypeSafe.PrepareOptions/OutputDirectories-apidoc) { get; } | Corresponds to command line option `-o, --outputDirectory=VALUE` |
| [OutputRoot](TypeSafe.PrepareOptions/OutputRoot-apidoc) { get; } | Corresponds to dotnet test option `/p:AltCoverOutputRoot` |
| [PathFilter](TypeSafe.PrepareOptions/PathFilter-apidoc) { get; } | Corresponds to command line option `-p, --pathFilter=VALUE` |
| [Report](TypeSafe.PrepareOptions/Report-apidoc) { get; } | Corresponds to command line option `-r, --report=VALUE` |
| [ReportFormat](TypeSafe.PrepareOptions/ReportFormat-apidoc) { get; } | Corresponds to command line option `--reportFormat=VALUE` |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# TypeSafe.PrepareOptions.OutputRoot property

Corresponds to dotnet test option `/p:AltCoverOutputRoot`

```csharp
public FilePath OutputRoot { get; }
```

## See Also

* class [FilePath](../TypeSafe.FilePath-apidoc)
* class [PrepareOptions](../TypeSafe.PrepareOptions-apidoc)
* namespace [AltCover](../../AltCover.Engine-apidoc)

<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Engine.dll -->
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public PrepareOptions(DirectoryPaths inputDirectories, DirectoryPaths outputDire
Flag save, Flag zipFile, Flag methodPoint, Flag singleVisit, Flag lineCover, Flag branchCover,
CommandLine commandLine, Flag exposeReturnCode, Flag sourceLink, Flag defer, Flag localSource,
Flag visibleBranches, StaticFormat showStatic, Flag showGenerated, TraceLevel verbosity,
Flag trivia)
Flag trivia, FilePath outputRoot)
```

## See Also
Expand Down
1 change: 1 addition & 0 deletions docs/AltCover.Engine/Primitive-fsapidoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ The members correspond to the like-named command line options for `AltCover`, ex
ShowGenerated: bool
Verbosity : System.Diagnostics.TraceLevel
Trivia: bool
OutputRoot : string
}
with
static member Create : unit -> PrepareOptions
Expand Down
1 change: 1 addition & 0 deletions docs/AltCover.Engine/TypeSafe-fsapidoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,7 @@ The members correspond to the like-named command line options for `AltCover`, ex
ShowGenerated: Flag
Verbosity : System.Diagnostics.TraceLevel
Trivia: Flag
OutputRoot : FilePath
}
with
static member Create : unit -> PrepareOptions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ The members correspond to the like-named command line options for `AltCover`, ex
abstract member ShowGenerated : bool with get
abstract member Verbosity : System.Diagnostics.TraceLevel with get
abstract member Trivia : bool with get
abstract member OutputRoot : string with get
```


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ The members correspond to the like-named command line options for `AltCover`, ex
member ShowGenerated : bool
member Verbosity : System.Diagnostics.TraceLevel
member Trivia: bool with get
member OutputRoot : string with get
```


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ The members correspond to the like-named command line options for `AltCover`, ex
ShowGenerated: bool
Verbosity : System.Diagnostics.TraceLevel
Trivia: bool
OutputRoot : string
}
with
static member Create : unit -> PrepareOptions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,7 @@ The members correspond to the like-named command line options for `AltCover`, ex
ShowGenerated: Flag
Verbosity : System.Diagnostics.TraceLevel
Trivia: Flag
OutputRoot : FilePath
}
with
static member Create : unit -> PrepareOptions
Expand Down
44 changes: 26 additions & 18 deletions docs/AltCover.Fake.DotNet.Testing.AltCover/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@ Make one of these
#r "nuget: AltCover.Fake"
let prep =
AltCoverFake.DotNet.Testing.AltCover.PrepareOptions.Primitive
{ AltCoverFake.DotNet.Testing.Primitive.PrepareOptions.Create() with
XmlReport = "./__UnitTestWithAltCover.xml"
OutputDirectories = [| "./__UnitTestWithAltCover" |]
StrongNameKey = "./Build/Infrastructure.snk"
ReportFormat = "NCover"
InPlace = false
Save = false }
|> AltCoverFake.DotNet.Testing.AltCoverCommand.Prepare
AltCoverFake.DotNet.Testing.AltCover.PrepareOptions.Primitive
{ AltCoverFake.DotNet.Testing.Primitive.PrepareOptions.Create() with
XmlReport = "./__UnitTestWithAltCover.xml"
OutputDirectories = [| "./__UnitTestWithAltCover" |]
StrongNameKey = "./Build/Infrastructure.snk"
ReportFormat = "NCover"
InPlace = false
Save = false }
|> AltCoverFake.DotNet.Testing.AltCoverCommand.Prepare
{ AltCoverFake.DotNet.Testing.AltCoverCommand.Options.Create prep with
ToolPath = "altcover"
Expand All @@ -67,23 +67,31 @@ let prep =
#r "nuget: AltCover.Fake"
#r "nuget: Fake.DotNet.Cli"
let ForceTrue = AltCoverFake.DotNet.Testing.DotNet.CLIOptions.Force true
let ForceTrue =
AltCoverFake.DotNet.Testing.DotNet.CLIOptions.Force true
let prep = AltCoverFake.DotNet.Testing.Primitive.PrepareOptions.Create()
let prep =
AltCoverFake.DotNet.Testing.Primitive.PrepareOptions.Create()
let coll = AltCoverFake.DotNet.Testing.Primitive.CollectOptions.Create()
let coll =
AltCoverFake.DotNet.Testing.Primitive.CollectOptions.Create()
let prep1 =
{ prep with
CallContext = [ "[Fact]"; "0" ]
AssemblyFilter = [| "xunit" |] }
{ prep with
CallContext = [ "[Fact]"; "0" ]
AssemblyFilter = [| "xunit" |] }
let prepare = AltCoverFake.DotNet.Testing.AltCover.PrepareOptions.Primitive prep1
let prepare =
AltCoverFake.DotNet.Testing.AltCover.PrepareOptions.Primitive prep1
let collect =
AltCoverFake.DotNet.Testing.AltCover.CollectOptions.Primitive { coll with SummaryFormat = "+B" }
AltCoverFake.DotNet.Testing.AltCover.CollectOptions.Primitive
{ coll with SummaryFormat = "+B" }
open AltCoverFake.DotNet.DotNet // extension method WithAltCoverOptions
Fake.DotNet.DotNet.test (fun to' -> to'.WithAltCoverOptions prepare collect ForceTrue) "dotnettest.fsproj"
Fake.DotNet.DotNet.test
(fun to' -> to'.WithAltCoverOptions prepare collect ForceTrue)
"dotnettest.fsproj"
```
23 changes: 15 additions & 8 deletions docs/Fake-and-Cake-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,21 +32,28 @@ with the relevant script fragment (based on [the AltCover build script here](htt
#r "nuget: AltCover.Api"
#r "nuget: Fake.DotNet.Cli"
let ForceTrue = AltCover.DotNet.CLIOptions.Force true
let ForceTrue =
AltCover.DotNet.CLIOptions.Force true
let p =
{ AltCover.Primitive.PrepareOptions.Create() with
CallContext = [| "[Fact]"; "0" |]
AssemblyFilter = [| "xunit" |] }
{ AltCover.Primitive.PrepareOptions.Create() with
CallContext = [| "[Fact]"; "0" |]
AssemblyFilter = [| "xunit" |] }
let prepare = AltCover.AltCover.PrepareOptions.Primitive p
let prepare =
AltCover.AltCover.PrepareOptions.Primitive p
let c = AltCover.Primitive.CollectOptions.Create()
let c =
AltCover.Primitive.CollectOptions.Create()
let collect = AltCover.AltCover.CollectOptions.Primitive c
let collect =
AltCover.AltCover.CollectOptions.Primitive c
open AltCover.Fake.DotNet // extension method WithAltCoverOptions
Fake.DotNet.DotNet.test (fun to' -> to'.WithAltCoverOptions prepare collect ForceTrue) "dotnettest.fsproj"
Fake.DotNet.DotNet.test
(fun to' -> to'.WithAltCoverOptions prepare collect ForceTrue)
"dotnettest.fsproj"
```

Expand Down
Loading

0 comments on commit 0361473

Please sign in to comment.