[skip ci] Update release notes & project documentation

AltCover.DotNet/DotNet.fs

@@ -145,7 +145,7 @@ module DotNet =
                       "AvoidMethodWithUnusedGenericTypeRule",
                       Justification = "It just be like that")>]
     let internal toCollectListArgArgumentList (collect: Abstract.ICollectOptions) =
-      [ fromList, "Packages", collect.Packages ] //=`"pipe `'|'` separated list of method name regexs"
+      [ fromList, "Packages", collect.Packages ] //=`"pipe `'|'` separated list of source root paths"
 
     let internal toSharedFromValueArgumentList
       (verbosity: System.Diagnostics.TraceLevel)

AltCover.Engine/TypeSafe.fsi

@@ -118,7 +118,7 @@ namespace AltCoverFake.DotNet.Testing
 // ### Cobertura package roots
 // ```
     ///<summary>
-    /// Corresponds to a value after `-- ` on the command line
+    /// Corresponds to a cobertura package source root
     ///</summary>
     [<NoComparison>]
     type Package =
@@ -128,13 +128,13 @@ namespace AltCoverFake.DotNet.Testing
       | Package of System.String
       with
         ///<summary>
-        /// Returns the string to be used in the effective command line
+        /// Returns the string to be used as a package root
         ///</summary>
-        ///<returns>the string to be used in the effective command line</returns>
+        ///<returns>the string to be used as a package root</returns>
         member AsString : unit -> System.String
       end
     ///<summary>
-    /// Corresponds to the values after `-- ` on the command line
+    /// Corresponds to a collection of cobertura package source roots
     ///</summary>
     [<NoComparison>]
     type Packages =
@@ -148,9 +148,9 @@ namespace AltCoverFake.DotNet.Testing
       | NoPackage
       with
         ///<summary>
-        /// Returns the strings to be used in the effective command line
+        /// Returns the strings to be used to be used as package roots
         ///</summary>
-        ///<returns>the strings to be used in the effective command line</returns>
+        ///<returns>the strings to be used as package roots</returns>
         member AsStrings : unit -> seq<System.String>
       end
 // ```

AltCover.PowerShell/CoverageFormats.fs

@@ -249,7 +249,7 @@ type ConvertToCoberturaCommand() =
   member val OutputFile: string = String.Empty with get, set
 
   /// <summary>
-  /// <para type="description">Output as file path</para>
+  /// <para type="description">Package source roots</para>
   /// </summary>
   [<Parameter(ParameterSetName = "XmlDoc",
               Mandatory = false,

ReleaseNotes.md

@@ -3,7 +3,9 @@
 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
 
-# (Habu series release 33)
+# (Habu series release 34)
+
+# 8.9.3 (Habu series release 33)
 * Add `-p/--package` and equivalents to specify package roots for Cobertura output for all coverage collection methods, plus the PowerShell `ConvertTo-Cobertura` cmdlet
 * [ADVISORY] The Fake.build related assemblies (in the `altcover.api` and `altcover.fake` packages) support Fake 6.1.0
 * [PERFORMANCE] revise the OpenCover to LCov conversion to speed the mapping of methods from source files.

docs/AltCover.Base/AltCover.Base-apidoc.md

@@ -0,0 +1,3 @@
+# AltCover.Base assembly
+
+<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Base.dll -->

docs/AltCover.Cake/AltCover.Cake/CollectOptions-apidoc.md

@@ -17,6 +17,7 @@ public class CollectOptions
 | [ExposeReturnCode](CollectOptions/ExposeReturnCode-apidoc) { get; } | Gets whether to expose a program return code (overridden by the MSBuild integration) |
 | virtual [LcovReport](CollectOptions/LcovReport-apidoc) { get; } | Corresponds to command line option `-l, --lcovReport=VALUE` |
 | virtual [OutputFile](CollectOptions/OutputFile-apidoc) { get; } | Corresponds to command line option `-o, --outputFile=VALUE` |
+| [Packages](CollectOptions/Packages-apidoc) { get; } | Corresponds to command line option `-p, --package=VALUE` |
 | [RecorderDirectory](CollectOptions/RecorderDirectory-apidoc) { get; } | Gets the recorder directory (overridden by the MSBuild integration) |
 | virtual [SummaryFormat](CollectOptions/SummaryFormat-apidoc) { get; } | Corresponds to command line option `--teamcity[=VALUE]` |
 | virtual [Threshold](CollectOptions/Threshold-apidoc) { get; } | Corresponds to command line option `-t, --threshold=VALUE` |

docs/AltCover.Cake/AltCover.Cake/CollectOptions/Packages-apidoc.md

@@ -0,0 +1,14 @@
+# CollectOptions.Packages property
+
+Corresponds to command line option `-p, --package=VALUE`
+
+```csharp
+public IEnumerable<string> Packages { get; }
+```
+
+## See Also
+
+* class [CollectOptions](../CollectOptions-apidoc)
+* namespace [AltCover.Cake](../../AltCover.Cake-apidoc)
+
+<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Cake.dll -->

docs/AltCover.DotNet/AltCover/Options.Collect-apidoc.md

@@ -15,6 +15,7 @@ public class Collect
 | [ExposeReturnCode](Options.Collect/ExposeReturnCode-apidoc) { get; set; } |  |
 | [LcovReport](Options.Collect/LcovReport-apidoc) { get; set; } |  |
 | [OutputFile](Options.Collect/OutputFile-apidoc) { get; set; } |  |
+| [Packages](Options.Collect/Packages-apidoc) { get; set; } |  |
 | [RecorderDirectory](Options.Collect/RecorderDirectory-apidoc) { get; set; } |  |
 | [SummaryFormat](Options.Collect/SummaryFormat-apidoc) { get; set; } |  |
 | [Threshold](Options.Collect/Threshold-apidoc) { get; set; } |  |

docs/AltCover.DotNet/AltCover/Options.Collect/Packages-apidoc.md

@@ -0,0 +1,12 @@
+# Options.Collect.Packages property
+
+```csharp
+public IEnumerable<string> Packages { get; set; }
+```
+
+## See Also
+
+* class [Collect](../Options.Collect-apidoc)
+* namespace [AltCover](../../AltCover.DotNet-apidoc)
+
+<!-- DO NOT EDIT: generated by xmldocmd for AltCover.DotNet.dll -->

docs/AltCover.Engine/Abstract-fsapidoc.md

@@ -34,6 +34,7 @@ The members correspond to the like-named command line options for `AltCover Runn
     abstract member LcovReport : String with get
     abstract member Threshold : String with get
     abstract member Cobertura : String with get
+    abstract member Packages : IEnumerable<String> with get
     abstract member OutputFile : String with get
     abstract member CommandLine : IEnumerable<String> with get
     abstract member ExposeReturnCode : bool with get

docs/AltCover.Engine/AltCover-fsapidoc.md

@@ -55,6 +55,7 @@ The members correspond to the like-named command line options for `AltCover Runn
         member LcovReport : System.String
         member Threshold : System.String
         member Cobertura : System.String
+        member Packages : seq<System.String>
         member OutputFile : System.String
         member CommandLine : seq<string>
         member ExposeReturnCode : bool

docs/AltCover.Engine/AltCover/Abstract.ICollectOptions-apidoc.md

@@ -30,6 +30,7 @@ public interface ICollectOptions
 | [ExposeReturnCode](Abstract.ICollectOptions/ExposeReturnCode-apidoc) { get; } | Corresponds to the converse of command line option `--dropReturnCode ` |
 | [LcovReport](Abstract.ICollectOptions/LcovReport-apidoc) { get; } | Corresponds to command line option `-l, --lcovReport=VALUE` |
 | [OutputFile](Abstract.ICollectOptions/OutputFile-apidoc) { get; } | Corresponds to command line option `-o, --outputFile=VALUE` |
+| [Packages](Abstract.ICollectOptions/Packages-apidoc) { get; } | Corresponds to command line option `-p, --package=VALUE` |
 | [RecorderDirectory](Abstract.ICollectOptions/RecorderDirectory-apidoc) { get; } | Corresponds to command line option `-r, --recorderDirectory=VALUE` |
 | [SummaryFormat](Abstract.ICollectOptions/SummaryFormat-apidoc) { get; } | Corresponds to command line option `--teamcity[=VALUE]` |
 | [Threshold](Abstract.ICollectOptions/Threshold-apidoc) { get; } | Corresponds to command line option `-t, --threshold=VALUE` |

docs/AltCover.Engine/AltCover/Abstract.ICollectOptions/Packages-apidoc.md

@@ -0,0 +1,14 @@
+# Abstract.ICollectOptions.Packages property
+
+Corresponds to command line option `-p, --package=VALUE`
+
+```csharp
+public IEnumerable<string> Packages { get; }
+```
+
+## See Also
+
+* interface [ICollectOptions](../Abstract.ICollectOptions-apidoc)
+* namespace [AltCover](../../AltCover.Engine-apidoc)
+
+<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Engine.dll -->

docs/AltCover.Engine/AltCover/AltCover.CollectOptions-apidoc.md

@@ -19,6 +19,7 @@ public abstract class CollectOptions : IEquatable<CollectOptions>, IStructuralEq
 | [ExposeReturnCode](AltCover.CollectOptions/ExposeReturnCode-apidoc) { get; } | Corresponds to the converse of command line option `--dropReturnCode ` |
 | [LcovReport](AltCover.CollectOptions/LcovReport-apidoc) { get; } | Corresponds to command line option `-l, --lcovReport=VALUE` |
 | [OutputFile](AltCover.CollectOptions/OutputFile-apidoc) { get; } | Corresponds to command line option `-o, --outputFile=VALUE` |
+| [Packages](AltCover.CollectOptions/Packages-apidoc) { get; } | Corresponds to command line option `-p, --package=VALUE` |
 | [RecorderDirectory](AltCover.CollectOptions/RecorderDirectory-apidoc) { get; } | Corresponds to command line option `-r, --recorderDirectory=VALUE` |
 | [SummaryFormat](AltCover.CollectOptions/SummaryFormat-apidoc) { get; } | Corresponds to command line option `--teamcity[=VALUE]` |
 | [Threshold](AltCover.CollectOptions/Threshold-apidoc) { get; } | Corresponds to command line option `-t, --threshold=VALUE` |

docs/AltCover.Engine/AltCover/AltCover.CollectOptions/Packages-apidoc.md

@@ -0,0 +1,14 @@
+# AltCover.CollectOptions.Packages property
+
+Corresponds to command line option `-p, --package=VALUE`
+
+```csharp
+public IEnumerable<string> Packages { get; }
+```
+
+## See Also
+
+* class [CollectOptions](../AltCover.CollectOptions-apidoc)
+* namespace [AltCover](../../AltCover.Engine-apidoc)
+
+<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Engine.dll -->

docs/AltCover.Engine/AltCover/Collect-apidoc.md

@@ -17,6 +17,7 @@ public class Collect : Task
 | [ExposeReturnCode](Collect/ExposeReturnCode-apidoc) { get; set; } | Corresponds to the converse of command line option `--dropReturnCode ` |
 | [LcovReport](Collect/LcovReport-apidoc) { get; set; } | Corresponds to command line option `-l, --lcovReport=VALUE` |
 | [OutputFile](Collect/OutputFile-apidoc) { get; set; } | Corresponds to command line option `-o, --outputFile=VALUE` |
+| [Packages](Collect/Packages-apidoc) { get; set; } | Corresponds to command line option `-p, --package=VALUE` |
 | [RecorderDirectory](Collect/RecorderDirectory-apidoc) { get; set; } | Corresponds to command line option `-r, --recorderDirectory=VALUE`; a required parameter |
 | [Summary](Collect/Summary-apidoc) { get; } | Task output calue, the summary of coverage. |
 | [SummaryFormat](Collect/SummaryFormat-apidoc) { get; set; } | Corresponds to command line option `--teamcity[=VALUE]` |

docs/AltCover.Engine/AltCover/Collect/Packages-apidoc.md

@@ -0,0 +1,14 @@
+# Collect.Packages property
+
+Corresponds to command line option `-p, --package=VALUE`
+
+```csharp
+public string[] Packages { get; set; }
+```
+
+## See Also
+
+* class [Collect](../Collect-apidoc)
+* namespace [AltCover](../../AltCover.Engine-apidoc)
+
+<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Engine.dll -->

docs/AltCover.Engine/AltCover/Primitive.CollectOptions-apidoc.md

@@ -18,6 +18,7 @@ public sealed class CollectOptions : IEquatable<CollectOptions>, IStructuralEqua
 | [ExposeReturnCode](Primitive.CollectOptions/ExposeReturnCode-apidoc) { get; } | Corresponds to the converse of command line option `--dropReturnCode ` |
 | [LcovReport](Primitive.CollectOptions/LcovReport-apidoc) { get; } | Corresponds to command line option `-l, --lcovReport=VALUE` |
 | [OutputFile](Primitive.CollectOptions/OutputFile-apidoc) { get; } | Corresponds to command line option `-o, --outputFile=VALUE` |
+| [Packages](Primitive.CollectOptions/Packages-apidoc) { get; } | Corresponds to command line option `-p, --package=VALUE` |
 | [RecorderDirectory](Primitive.CollectOptions/RecorderDirectory-apidoc) { get; } | Corresponds to command line option `-r, --recorderDirectory=VALUE` |
 | [SummaryFormat](Primitive.CollectOptions/SummaryFormat-apidoc) { get; } | Corresponds to command line option `--teamcity[=VALUE]` |
 | [Threshold](Primitive.CollectOptions/Threshold-apidoc) { get; } | Corresponds to command line option `-t, --threshold=VALUE` |

docs/AltCover.Engine/AltCover/Primitive.CollectOptions/CollectOptions-apidoc.md

@@ -2,9 +2,9 @@
 
 ```csharp
 public CollectOptions(string recorderDirectory, string workingDirectory, string executable, 
-    string lcovReport, string threshold, string cobertura, string outputFile, 
-    IEnumerable<string> commandLine, bool exposeReturnCode, string summaryFormat, 
-    TraceLevel verbosity)
+    string lcovReport, string threshold, string cobertura, IEnumerable<string> packages, 
+    string outputFile, IEnumerable<string> commandLine, bool exposeReturnCode, 
+    string summaryFormat, TraceLevel verbosity)
 ```
 
 ## See Also

docs/AltCover.Engine/AltCover/Primitive.CollectOptions/Packages-apidoc.md

@@ -0,0 +1,14 @@
+# Primitive.CollectOptions.Packages property
+
+Corresponds to command line option `-p, --package=VALUE`
+
+```csharp
+public IEnumerable<string> Packages { get; }
+```
+
+## See Also
+
+* class [CollectOptions](../Primitive.CollectOptions-apidoc)
+* namespace [AltCover](../../AltCover.Engine-apidoc)
+
+<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Engine.dll -->

docs/AltCover.Engine/AltCover/TypeSafe-apidoc.md

@@ -22,6 +22,8 @@ public static class TypeSafe
 | abstract class [FilterItem](TypeSafe.FilterItem-apidoc) | Corresponds to a filter entry |
 | abstract class [Filters](TypeSafe.Filters-apidoc) | Corresponds to a collection of filter entries |
 | abstract class [Flag](TypeSafe.Flag-apidoc) | Corresponds to a yes/no choice |
+| class [Package](TypeSafe.Package-apidoc) | Corresponds to a cobertura package source root |
+| abstract class [Packages](TypeSafe.Packages-apidoc) | Corresponds to a collection of cobertura package source roots |
 | class [PrepareOptions](TypeSafe.PrepareOptions-apidoc) | Command line options for `AltCover` |
 | class [ReportFormat](TypeSafe.ReportFormat-apidoc) | Corresponds to the desired format of the XML report |
 | class [StaticFormat](TypeSafe.StaticFormat-apidoc) | Corresponds to a an option for treating trivial methods |

docs/AltCover.Engine/AltCover/TypeSafe.CollectOptions-apidoc.md

@@ -18,6 +18,7 @@ public sealed class CollectOptions : IEquatable<CollectOptions>, IStructuralEqua
 | [ExposeReturnCode](TypeSafe.CollectOptions/ExposeReturnCode-apidoc) { get; } | Corresponds to the converse of command line option `--dropReturnCode ` |
 | [LcovReport](TypeSafe.CollectOptions/LcovReport-apidoc) { get; } | Corresponds to command line option `-l, --lcovReport=VALUE` |
 | [OutputFile](TypeSafe.CollectOptions/OutputFile-apidoc) { get; } | Corresponds to command line option `-o, --outputFile=VALUE` |
+| [Packages](TypeSafe.CollectOptions/Packages-apidoc) { get; } | Corresponds to command line option `-p, --package=VALUE` |
 | [RecorderDirectory](TypeSafe.CollectOptions/RecorderDirectory-apidoc) { get; } | Corresponds to command line option `-r, --recorderDirectory=VALUE` |
 | [SummaryFormat](TypeSafe.CollectOptions/SummaryFormat-apidoc) { get; } | Corresponds to command line option `--teamcity[=VALUE]` |
 | [Threshold](TypeSafe.CollectOptions/Threshold-apidoc) { get; } | Corresponds to command line option `-t, --threshold=VALUE` |

docs/AltCover.Engine/AltCover/TypeSafe.CollectOptions/CollectOptions-apidoc.md

@@ -3,7 +3,7 @@
 ```csharp
 public CollectOptions(DirectoryPath recorderDirectory, DirectoryPath workingDirectory, 
     FilePath executable, FilePath lcovReport, Threshold threshold, FilePath cobertura, 
-    FilePath outputFile, CommandLine commandLine, Flag exposeReturnCode, 
+    Packages packages, FilePath outputFile, CommandLine commandLine, Flag exposeReturnCode, 
     SummaryFormat summaryFormat, TraceLevel verbosity)
 ```
 
@@ -12,6 +12,7 @@ public CollectOptions(DirectoryPath recorderDirectory, DirectoryPath workingDire
 * class [DirectoryPath](../TypeSafe.DirectoryPath-apidoc)
 * class [FilePath](../TypeSafe.FilePath-apidoc)
 * class [Threshold](../TypeSafe.Threshold-apidoc)
+* class [Packages](../TypeSafe.Packages-apidoc)
 * class [CommandLine](../TypeSafe.CommandLine-apidoc)
 * class [Flag](../TypeSafe.Flag-apidoc)
 * class [SummaryFormat](../TypeSafe.SummaryFormat-apidoc)

docs/AltCover.Engine/AltCover/TypeSafe.CollectOptions/Packages-apidoc.md

@@ -0,0 +1,15 @@
+# TypeSafe.CollectOptions.Packages property
+
+Corresponds to command line option `-p, --package=VALUE`
+
+```csharp
+public Packages Packages { get; }
+```
+
+## See Also
+
+* class [Packages](../TypeSafe.Packages-apidoc)
+* class [CollectOptions](../TypeSafe.CollectOptions-apidoc)
+* namespace [AltCover](../../AltCover.Engine-apidoc)
+
+<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Engine.dll -->

docs/AltCover.Engine/AltCover/TypeSafe.Package-apidoc.md

@@ -0,0 +1,20 @@
+# TypeSafe.Package class
+
+Corresponds to a value after `-- ` on the command line
+
+```csharp
+public sealed class Package : IEquatable<Package>, IStructuralEquatable
+```
+
+## Public Members
+
+| name | description |
+| --- | --- |
+| static [NewPackage](TypeSafe.Package/NewPackage-apidoc)(…) |  |
+| [AsString](TypeSafe.Package/AsString-apidoc)() | Returns the string to be used as a package root |
+## See Also
+
+* class [TypeSafe](./TypeSafe-apidoc)
+* namespace [AltCover](../AltCover.Engine-apidoc)
+
+<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Engine.dll -->

docs/AltCover.Engine/AltCover/TypeSafe.Package/AsString-apidoc.md

@@ -0,0 +1,18 @@
+# TypeSafe.Package.AsString method
+
+Returns the string to be used as a package root
+
+```csharp
+public string AsString()
+```
+
+## Return Value
+
+the string to be used as a package root
+
+## See Also
+
+* class [Package](../TypeSafe.Package-apidoc)
+* namespace [AltCover](../../AltCover.Engine-apidoc)
+
+<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Engine.dll -->

docs/AltCover.Engine/AltCover/TypeSafe.Package/NewPackage-apidoc.md

@@ -0,0 +1,12 @@
+# TypeSafe.Package.NewPackage method
+
+```csharp
+public static Package NewPackage(string item)
+```
+
+## See Also
+
+* class [Package](../TypeSafe.Package-apidoc)
+* namespace [AltCover](../../AltCover.Engine-apidoc)
+
+<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Engine.dll -->

docs/AltCover.Engine/AltCover/TypeSafe.Packages-apidoc.md

@@ -0,0 +1,24 @@
+# TypeSafe.Packages class
+
+Corresponds to the values after `-- ` on the command line
+
+```csharp
+public abstract class Packages : IEquatable<Packages>, IStructuralEquatable
+```
+
+## Public Members
+
+| name | description |
+| --- | --- |
+| static [get_NoPackage](TypeSafe.Packages/get_NoPackage-apidoc)() |  |
+| static [NewPackages](TypeSafe.Packages/NewPackages-apidoc)(…) |  |
+| [AsStrings](TypeSafe.Packages/AsStrings-apidoc)() | Returns the strings to be used to be used as package roots |
+| class [Packages](TypeSafe.Packages.Packages-apidoc) | Strongly typed string collection |
+| static class [Tags](TypeSafe.Packages.Tags-apidoc) |  |
+
+## See Also
+
+* class [TypeSafe](./TypeSafe-apidoc)
+* namespace [AltCover](../AltCover.Engine-apidoc)
+
+<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Engine.dll -->

docs/AltCover.Engine/AltCover/TypeSafe.Packages.Packages-apidoc.md

@@ -0,0 +1,14 @@
+# TypeSafe.Packages.Packages class
+
+Strongly typed string collection
+
+```csharp
+public class Packages : Packages
+```
+
+## See Also
+
+* class [Packages](./TypeSafe.Packages-apidoc)
+* namespace [AltCover](../AltCover.Engine-apidoc)
+
+<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Engine.dll -->

docs/AltCover.Engine/AltCover/TypeSafe.Packages.Tags-apidoc.md

@@ -0,0 +1,19 @@
+# TypeSafe.Packages.Tags class
+
+```csharp
+public static class Tags
+```
+
+## Public Members
+
+| name | description |
+| --- | --- |
+| const [NoPackage](TypeSafe.Packages.Tags/NoPackage-apidoc) |  |
+| const [Packages](TypeSafe.Packages.Tags/Packages-apidoc) |  |
+
+## See Also
+
+* class [Packages](./TypeSafe.Packages-apidoc)
+* namespace [AltCover](../AltCover.Engine-apidoc)
+
+<!-- DO NOT EDIT: generated by xmldocmd for AltCover.Engine.dll -->