Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
SteveGilham committed Nov 14, 2024
1 parent abb5ba8 commit 79af67e
Show file tree
Hide file tree
Showing 44 changed files with 117 additions and 124 deletions.
5 changes: 4 additions & 1 deletion ReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
A. Start with the Quick Start guide : https://github.com/SteveGilham/altcover/wiki/QuickStart-Guide and
read the FAQ : https://github.com/SteveGilham/altcover/wiki/FAQ

# (Indori series release 1)
# (Indori series release 2)

# 9.0.1 (Indori series release 1)
* Net9.0 support
* [BREAKING] Minimum platforms for the tools and API are `net472`, `netstandard2.0` and `net8.0`. *NOTE* the recorder assembly still targets `net20` (or `net46` when `async` is detected)
* [BREAKING] SDK updates to latest current for Cake (5.0.0) and MSBuild (17.12.6) packages; build with Fake.build 6.1.3 but supports back to 6.0.0
* [BREAKING] API change : `--all` and `--eager` replace `--single` and `--defer`, so the default behaviour is now deferred (Unload/Exit time) reporting, and first visit only per context. *NOTE* in some cases, use of .Net Framework `AppDomain`s may require the use of `--eager` as the unload handler gives no guarantees about execution time.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This method is a `[CakeMethodAlias]` extension method on `ICakeContext`, and `[C

```csharp
public static void DotNetTest(this ICakeContext context, FilePath project,
DotNetCoreTestSettings testSettings, CoverageSettings coverageSettings)
DotNetTestSettings testSettings, CoverageSettings coverageSettings)
```

| parameter | description |
Expand Down
4 changes: 2 additions & 2 deletions docs/AltCover.Cake/AltCover.Cake/PrepareOptions-apidoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,16 @@ public class PrepareOptions
| name | description |
| --- | --- |
| [PrepareOptions](PrepareOptions/PrepareOptions-apidoc)() | The default constructor. |
| virtual [All](PrepareOptions/All-apidoc) { get; } | Corresponds to command line option `--all` |
| virtual [AssemblyExcludeFilter](PrepareOptions/AssemblyExcludeFilter-apidoc) { get; } | Corresponds to command line option `-e, --assemblyExcludeFilter=VALUE` |
| virtual [AssemblyFilter](PrepareOptions/AssemblyFilter-apidoc) { get; } | Corresponds to command line option `-s, --assemblyFilter=VALUE` |
| virtual [AttributeFilter](PrepareOptions/AttributeFilter-apidoc) { get; } | Corresponds to command line option `-a, --attributeFilter=VALUE` |
| virtual [AttributeTopLevel](PrepareOptions/AttributeTopLevel-apidoc) { get; } | Corresponds to command line option `--attributetoplevel=VALUE` |
| virtual [BranchCover](PrepareOptions/BranchCover-apidoc) { get; } | Corresponds to command line option `--branchcover` |
| virtual [CallContext](PrepareOptions/CallContext-apidoc) { get; } | Corresponds to command line option `-c, --callContext=VALUE` |
| [CommandLine](PrepareOptions/CommandLine-apidoc) { get; } | Gets the command line (overridden by the MSBuild integration) |
| [Defer](PrepareOptions/Defer-apidoc) { get; } | Gets whether to defer coverage reporting (overridden by the MSBuild integration) |
| virtual [Dependencies](PrepareOptions/Dependencies-apidoc) { get; } | Corresponds to command line option `-d, --dependency=VALUE` |
| [Eager](PrepareOptions/Eager-apidoc) { get; } | Gets whether to defer coverage reporting (overridden by the MSBuild integration) |
| [ExposeReturnCode](PrepareOptions/ExposeReturnCode-apidoc) { get; } | Gets whether to expose a program return code (overridden by the MSBuild integration) |
| virtual [FileFilter](PrepareOptions/FileFilter-apidoc) { get; } | Corresponds to command line option `-f, --fileFilter=VALUE` |
| virtual [InPlace](PrepareOptions/InPlace-apidoc) { get; } | Corresponds to command line option `--inplace` |
Expand All @@ -39,7 +40,6 @@ public class PrepareOptions
| virtual [Save](PrepareOptions/Save-apidoc) { get; } | Corresponds to command line option `--save` |
| virtual [ShowGenerated](PrepareOptions/ShowGenerated-apidoc) { get; } | Corresponds to command line option `--showGenerated` |
| virtual [ShowStatic](PrepareOptions/ShowStatic-apidoc) { get; } | Corresponds to command line option `--showstatic[=VALUE]` |
| virtual [SingleVisit](PrepareOptions/SingleVisit-apidoc) { get; } | Corresponds to command line option `--single` |
| 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` |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# PrepareOptions.SingleVisit property
# PrepareOptions.All property

Corresponds to command line option `--single`
Corresponds to command line option `--all`

```csharp
public virtual bool SingleVisit { get; }
public virtual bool All { get; }
```

## See Also
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# PrepareOptions.Defer property
# PrepareOptions.Eager property

Gets whether to defer coverage reporting (overridden by the MSBuild integration)

```csharp
public bool Defer { get; }
public bool Eager { get; }
```

## See Also
Expand Down
4 changes: 2 additions & 2 deletions docs/AltCover.DotNet/AltCover/Options.Prepare-apidoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,16 @@ public class Prepare
| name | description |
| --- | --- |
| [Prepare](Options.Prepare/Prepare-apidoc)() | The default constructor. |
| [All](Options.Prepare/All-apidoc) { get; set; } | |
| [AssemblyExcludeFilter](Options.Prepare/AssemblyExcludeFilter-apidoc) { getset; } | |
| [AssemblyFilter](Options.Prepare/AssemblyFilter-apidoc) { getset; } | |
| [AttributeFilter](Options.Prepare/AttributeFilter-apidoc) { getset; } | |
| [AttributeTopLevel](Options.Prepare/AttributeTopLevel-apidoc) { getset; } | |
| [BranchCover](Options.Prepare/BranchCover-apidoc) { getset; } | |
| [CallContext](Options.Prepare/CallContext-apidoc) { getset; } | |
| [CommandLine](Options.Prepare/CommandLine-apidoc) { getset; } | |
| [Defer](Options.Prepare/Defer-apidoc) { getset; } | |
| [Dependencies](Options.Prepare/Dependencies-apidoc) { getset; } | |
| [Eager](Options.Prepare/Eager-apidoc) { getset; } | |
| [ExposeReturnCode](Options.Prepare/ExposeReturnCode-apidoc) { getset; } | |
| [FileFilter](Options.Prepare/FileFilter-apidoc) { getset; } | |
| [InPlace](Options.Prepare/InPlace-apidoc) { getset; } | |
Expand All @@ -37,7 +38,6 @@ public class Prepare
| [Save](Options.Prepare/Save-apidoc) { getset; } | |
| [ShowGenerated](Options.Prepare/ShowGenerated-apidoc) { getset; } | |
| [ShowStatic](Options.Prepare/ShowStatic-apidoc) { getset; } | |
| [SingleVisit](Options.Prepare/SingleVisit-apidoc) { getset; } | |
| [SourceLink](Options.Prepare/SourceLink-apidoc) { getset; } | |
| [StrongNameKey](Options.Prepare/StrongNameKey-apidoc) { getset; } | |
| [SymbolDirectories](Options.Prepare/SymbolDirectories-apidoc) { getset; } | |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Options.Prepare.Defer property
# Options.Prepare.All property

```csharp
public bool Defer { get; set; }
public bool All { get; set; }
```

## See Also
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Options.Prepare.SingleVisit property
# Options.Prepare.Eager property

```csharp
public bool SingleVisit { get; set; }
public bool Eager { get; set; }
```

## See Also
Expand Down
5 changes: 2 additions & 3 deletions docs/AltCover.Engine/Abstract-fsapidoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ The members correspond to the like-named command line options for `AltCover Runn
The members correspond to the like-named command line options for `AltCover`, except
* `ExposeReturnCode` being the converse of the `dropReturnCode` option
* `CommandLine` being the material after a `-- `
* `SingleVisit` being the name for `--single`

```
type IPrepareOptions =
Expand All @@ -73,13 +72,13 @@ The members correspond to the like-named command line options for `AltCover`, ex
abstract member Save : bool with get
abstract member ZipFile : bool with get
abstract member MethodPoint : bool with get
abstract member SingleVisit : bool with get
abstract member All : bool with get
abstract member LineCover : bool with get
abstract member BranchCover : bool with get
abstract member CommandLine : IEnumerable<String> with get
abstract member ExposeReturnCode : bool with get
abstract member SourceLink : bool with get
abstract member Defer : bool with get
abstract member Eager : bool with get
abstract member LocalSource : bool with get
abstract member VisibleBranches : bool with get
abstract member ShowStatic : string with get
Expand Down
5 changes: 2 additions & 3 deletions docs/AltCover.Engine/AltCover-fsapidoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@ The property members corresponding to the command line options read the values f
The members correspond to the like-named command line options for `AltCover`, except
* `ExposeReturnCode` being the converse of the `dropReturnCode` option
* `CommandLine` being the material after a `-- `
* `SingleVisit` being the name for `--single`

```
[<NoComparison>]
Expand Down Expand Up @@ -116,13 +115,13 @@ The members correspond to the like-named command line options for `AltCover`, ex
member Save : bool
member ZipFile : bool
member MethodPoint : bool
member SingleVisit : bool
member All : bool
member LineCover : bool
member BranchCover : bool
member CommandLine : seq<System.String>
member ExposeReturnCode : bool
member SourceLink : bool
member Defer : bool
member Eager : bool
member LocalSource : bool
member VisibleBranches : bool
member ShowStatic : string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,16 @@ public interface IPrepareOptions

| name | description |
| --- | --- |
| [All](Abstract.IPrepareOptions/All-apidoc) { get; } | Corresponds to command line option `--all` |
| [AssemblyExcludeFilter](Abstract.IPrepareOptions/AssemblyExcludeFilter-apidoc) { get; } | Corresponds to command line option `-e, --assemblyExcludeFilter=VALUE` |
| [AssemblyFilter](Abstract.IPrepareOptions/AssemblyFilter-apidoc) { get; } | Corresponds to command line option `-s, --assemblyFilter=VALUE` |
| [AttributeFilter](Abstract.IPrepareOptions/AttributeFilter-apidoc) { get; } | Corresponds to command line option `-a, --attributeFilter=VALUE` |
| [AttributeTopLevel](Abstract.IPrepareOptions/AttributeTopLevel-apidoc) { get; } | Corresponds to command line option `--attributetoplevel=VALUE` |
| [BranchCover](Abstract.IPrepareOptions/BranchCover-apidoc) { get; } | Corresponds to command line option `--branchcover` |
| [CallContext](Abstract.IPrepareOptions/CallContext-apidoc) { get; } | Corresponds to command line option `-c, --callContext=VALUE` |
| [CommandLine](Abstract.IPrepareOptions/CommandLine-apidoc) { get; } | Corresponds to the command line to run, given after a `-- ` |
| [Defer](Abstract.IPrepareOptions/Defer-apidoc) { get; } | Corresponds to command line option `--defer` |
| [Dependencies](Abstract.IPrepareOptions/Dependencies-apidoc) { get; } | Corresponds to command line option `-d, --dependency=VALUE` |
| [Eager](Abstract.IPrepareOptions/Eager-apidoc) { get; } | Corresponds to command line option `--eager` |
| [ExposeReturnCode](Abstract.IPrepareOptions/ExposeReturnCode-apidoc) { get; } | Corresponds to the converse of command line option `--dropReturnCode ` |
| [FileFilter](Abstract.IPrepareOptions/FileFilter-apidoc) { get; } | Corresponds to command line option `-f, --fileFilter=VALUE` |
| [InPlace](Abstract.IPrepareOptions/InPlace-apidoc) { get; } | Corresponds to command line option `--inplace` |
Expand All @@ -52,7 +53,6 @@ public interface IPrepareOptions
| [Save](Abstract.IPrepareOptions/Save-apidoc) { get; } | Corresponds to command line option `--save` |
| [ShowGenerated](Abstract.IPrepareOptions/ShowGenerated-apidoc) { get; } | Corresponds to command line option `--showGenerated` |
| [ShowStatic](Abstract.IPrepareOptions/ShowStatic-apidoc) { get; } | Corresponds to command line option `--showstatic[=VALUE]` |
| [SingleVisit](Abstract.IPrepareOptions/SingleVisit-apidoc) { get; } | Corresponds to command line option `--single` |
| [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` |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Abstract.IPrepareOptions.Defer property
# Abstract.IPrepareOptions.All property

Corresponds to command line option `--defer`
Corresponds to command line option `--all`

```csharp
public bool Defer { get; }
public bool All { get; }
```

## See Also
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Abstract.IPrepareOptions.SingleVisit property
# Abstract.IPrepareOptions.Eager property

Corresponds to command line option `--single`
Corresponds to command line option `--eager`

```csharp
public bool SingleVisit { get; }
public bool Eager { get; }
```

## See Also
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,16 @@ public abstract class PrepareOptions : IEquatable<PrepareOptions>, IStructuralEq
| static [NewAbstract](AltCover.PrepareOptions/NewAbstract-apidoc)(…) | |
| static [NewPrimitive](AltCover.PrepareOptions/NewPrimitive-apidoc)(…) | |
| static [NewTypeSafe](AltCover.PrepareOptions/NewTypeSafe-apidoc)(…) | |
| [All](AltCover.PrepareOptions/All-apidoc) { get; } | Corresponds to command line option `--all` |
| [AssemblyExcludeFilter](AltCover.PrepareOptions/AssemblyExcludeFilter-apidoc) { get; } | Corresponds to command line option `-e, --assemblyExcludeFilter=VALUE` |
| [AssemblyFilter](AltCover.PrepareOptions/AssemblyFilter-apidoc) { get; } | Corresponds to command line option `-s, --assemblyFilter=VALUE` |
| [AttributeFilter](AltCover.PrepareOptions/AttributeFilter-apidoc) { get; } | Corresponds to command line option `-a, --attributeFilter=VALUE` |
| [AttributeTopLevel](AltCover.PrepareOptions/AttributeTopLevel-apidoc) { get; } | Corresponds to command line option --attributetoplevel=VALUE` |
| [BranchCover](AltCover.PrepareOptions/BranchCover-apidoc) { get; } | Corresponds to command line option `--branchcover` |
| [CallContext](AltCover.PrepareOptions/CallContext-apidoc) { get; } | Corresponds to command line option `-c, --callContext=VALUE` |
| [CommandLine](AltCover.PrepareOptions/CommandLine-apidoc) { get; } | Corresponds to the command line to run, given after a `-- ` |
| [Defer](AltCover.PrepareOptions/Defer-apidoc) { get; } | Corresponds to command line option `--defer` |
| [Dependencies](AltCover.PrepareOptions/Dependencies-apidoc) { get; } | Corresponds to command line option `-d, --dependency=VALUE` |
| [Eager](AltCover.PrepareOptions/Eager-apidoc) { get; } | Corresponds to command line option `--eager` |
| [ExposeReturnCode](AltCover.PrepareOptions/ExposeReturnCode-apidoc) { get; } | Corresponds to the converse of command line option `--dropReturnCode ` |
| [FileFilter](AltCover.PrepareOptions/FileFilter-apidoc) { get; } | Corresponds to command line option `-f, --fileFilter=VALUE` |
| [InPlace](AltCover.PrepareOptions/InPlace-apidoc) { get; } | Corresponds to command line option `--inplace` |
Expand All @@ -41,7 +42,6 @@ public abstract class PrepareOptions : IEquatable<PrepareOptions>, IStructuralEq
| [Save](AltCover.PrepareOptions/Save-apidoc) { get; } | Corresponds to command line option `--save` |
| [ShowGenerated](AltCover.PrepareOptions/ShowGenerated-apidoc) { get; } | Corresponds to command line option `--showGenerated` |
| [ShowStatic](AltCover.PrepareOptions/ShowStatic-apidoc) { get; } | Corresponds to command line option `--showstatic[=VALUE]` |
| [SingleVisit](AltCover.PrepareOptions/SingleVisit-apidoc) { get; } | Corresponds to command line option `--single` |
| [SourceLink](AltCover.PrepareOptions/SourceLink-apidoc) { get; } | Corresponds to command line option `--sourcelink` |
| [StrongNameKey](AltCover.PrepareOptions/StrongNameKey-apidoc) { get; } | Corresponds to command line option `--sn, --strongNameKey=VALUE` |
| [SymbolDirectories](AltCover.PrepareOptions/SymbolDirectories-apidoc) { get; } | Corresponds to command line option `-y, --symbolDirectory=VALUE` |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# AltCover.PrepareOptions.Defer property
# AltCover.PrepareOptions.All property

Corresponds to command line option `--defer`
Corresponds to command line option `--all`

```csharp
public bool Defer { get; }
public bool All { get; }
```

## See Also
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# AltCover.PrepareOptions.SingleVisit property
# AltCover.PrepareOptions.Eager property

Corresponds to command line option `--single`
Corresponds to command line option `--eager`

```csharp
public bool SingleVisit { get; }
public bool Eager { get; }
```

## See Also
Expand Down
4 changes: 2 additions & 2 deletions docs/AltCover.Engine/AltCover/Prepare-apidoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,16 @@ public class Prepare : Task
| name | description |
| --- | --- |
| [Prepare](Prepare/Prepare-apidoc)() | The default constructor |
| [All](Prepare/All-apidoc) { get; set; } | Corresponds to command line option `--all` |
| [AssemblyExcludeFilter](Prepare/AssemblyExcludeFilter-apidoc) { getset; } | Corresponds to command line option `-e, --assemblyExcludeFilter=VALUE` |
| [AssemblyFilter](Prepare/AssemblyFilter-apidoc) { getset; } | Corresponds to command line option `-s, --assemblyFilter=VALUE` |
| [AttributeFilter](Prepare/AttributeFilter-apidoc) { getset; } | Corresponds to command line option `-a, --attributeFilter=VALUE` |
| [AttributeTopLevel](Prepare/AttributeTopLevel-apidoc) { getset; } | Corresponds to command line option --attributetoplevel=VALUE` |
| [BranchCover](Prepare/BranchCover-apidoc) { getset; } | Corresponds to command line option `--branchcover` |
| [CallContext](Prepare/CallContext-apidoc) { getset; } | Corresponds to command line option `-c, --callContext=VALUE` |
| [CommandLine](Prepare/CommandLine-apidoc) { getset; } | Corresponds to the command line to run, given after a `-- ` |
| [Defer](Prepare/Defer-apidoc) { getset; } | Corresponds to command line option `--defer` |
| [Dependencies](Prepare/Dependencies-apidoc) { getset; } | Corresponds to command line option `-d, --dependency=VALUE` |
| [Eager](Prepare/Eager-apidoc) { getset; } | Corresponds to command line option `--eager` |
| [ExposeReturnCode](Prepare/ExposeReturnCode-apidoc) { getset; } | Corresponds to the converse of command line option `--dropReturnCode ` |
| [FileFilter](Prepare/FileFilter-apidoc) { getset; } | Corresponds to command line option `-f, --fileFilter=VALUE` |
| [InPlace](Prepare/InPlace-apidoc) { getset; } | Corresponds to command line option `--inplace` |
Expand All @@ -38,7 +39,6 @@ public class Prepare : Task
| [Save](Prepare/Save-apidoc) { getset; } | Corresponds to command line option `--save` |
| [ShowGenerated](Prepare/ShowGenerated-apidoc) { getset; } | Corresponds to command line option `--showGenerated` |
| [ShowStatic](Prepare/ShowStatic-apidoc) { getset; } | Corresponds to command line option `--showstatic[=VALUE]` |
| [SingleVisit](Prepare/SingleVisit-apidoc) { getset; } | Corresponds to command line option `--single` |
| [SourceLink](Prepare/SourceLink-apidoc) { getset; } | Corresponds to command line option `--sourcelink` |
| [StrongNameKey](Prepare/StrongNameKey-apidoc) { getset; } | Corresponds to command line option `--sn, --strongNameKey=VALUE` |
| [SymbolDirectories](Prepare/SymbolDirectories-apidoc) { getset; } | Corresponds to command line option `-y, --symbolDirectory=VALUE` |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Prepare.Defer property
# Prepare.All property

Corresponds to command line option `--defer`
Corresponds to command line option `--all`

```csharp
public bool Defer { get; set; }
public bool All { get; set; }
```

## See Also
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Prepare.SingleVisit property
# Prepare.Eager property

Corresponds to command line option `--single`
Corresponds to command line option `--eager`

```csharp
public bool SingleVisit { get; set; }
public bool Eager { get; set; }
```

## See Also
Expand Down
Loading

0 comments on commit 79af67e

Please sign in to comment.