VsMetricsRunner Class

Summary

The VsMetrics runner.
Assembly
Cake.VsMetrics.dll
Namespace
Cake.VsMetrics
Base Types
graph BT Type-->Base0["Tool<VsMetricsSettings>"] Type["VsMetricsRunner"] class Type type-node

Syntax

public sealed class VsMetricsRunner : Tool<VsMetricsSettings>

Constructors

Methods

Name Value Summary
GetAlternativeToolPaths(VsMetricsSettings) IEnumerable<FilePath>
Gets the alternative tool paths to metrics.exe depending on the tool version.
GetToolExecutableNames() IEnumerable<string>
Gets the name of the tool executable.
GetToolName() string
Gets the name of the tool.
Run(IEnumerable<FilePath>, FilePath, VsMetricsSettings) void
Calculates code metrics for a collection of input files and saves the report in an output file.

Extension Methods

Name Value Summary
Dump<VsMetricsRunner>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<VsMetricsRunner>(VsMetricsRunner[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<VsMetricsRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<VsMetricsRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<VsMetricsRunner>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<VsMetricsRunner>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin