StyleCopReportSettings Class

Summary

A utility class for configuring stylecop output.
Assembly
Cake.StyleCop.dll
Namespace
Cake.Stylecop
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["StyleCopReportSettings"] class Type type-node

Syntax

public class StyleCopReportSettings

Constructors

Name Summary
StyleCopReportSettings() Creates a new instance of the StyleCopReportSettings class.

Properties

Name Value Summary
HtmlReportFile FilePath
Outputs an html report using the default stylesheet or a custom one if specified in StyleSheet
ResultFiles FilePathCollection
A collection of xml result files to merge for the report
StyleSheet FilePath
The StyleSheet Path

Extension Methods

Name Value Summary
AddResultFiles(FilePathCollection) StyleCopReportSettings
Allows multiple results files to be aggregated into a single report output.
Requires the Cake.StyleCop addin
Dump<StyleCopReportSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<StyleCopReportSettings>(StyleCopReportSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<StyleCopReportSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<StyleCopReportSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<StyleCopReportSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<StyleCopReportSettings>(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
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToHtmlReport(FilePath, FilePath) StyleCopReportSettings
Indicates the results should be outputted as an HTML report.
Requires the Cake.StyleCop addin