BaseRuleDescription Class

Summary

Base class for all rule descriptions.
graph BT Type-->Base0["Object"] Type["BaseRuleDescription"] class Type type-node Derived0["MsBuildRuleDescription"]-->Type click Derived0 "/api/Cake.Issues.MsBuild/MsBuildRuleDescription" Derived1["MarkdownlintRuleDescription"]-->Type click Derived1 "/api/Cake.Issues.Markdownlint/MarkdownlintRuleDescription" Derived2["FakeRuleDescription"]-->Type click Derived2 "/api/Cake.Issues.Testing/FakeRuleDescription"

Syntax

public class BaseRuleDescription

Constructors

Name Summary
BaseRuleDescription()

Properties

Name Value Summary
Rule string
Gets or sets the full identifier of the rule.

Extension Methods

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