This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.StyleCop.

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. From StyleCopSettingsExtensions Requires the Cake.StyleCop addin
Dump<StyleCopReportSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<StyleCopReportSettings>(StyleCopReportSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<StyleCopReportSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<StyleCopReportSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<StyleCopReportSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<StyleCopReportSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToHtmlReport(FilePath, FilePath)	StyleCopReportSettings	Indicates the results should be outputted as an HTML report. From StyleCopSettingsExtensions Requires the Cake.StyleCop addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin

StyleCopReportSettings Class

Summary

Syntax

Constructors

Properties

Extension Methods