MarkdownlintRuleDescription Class

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.Issues.Markdownlint.

Summary

Class describing rules appearing in Markdownlint logs.

Assembly

Cake.Issues.Markdownlint.dll

Namespace

Cake.Issues.Markdownlint

Base Types

Object
BaseRuleDescription

graph BT Type-->Base0["BaseRuleDescription"] click Base0 "/api/Cake.Issues/BaseRuleDescription" Base0-->Base1["Object"] Type["MarkdownlintRuleDescription"] class Type type-node

Syntax

public class MarkdownlintRuleDescription : BaseRuleDescription

Constructors

Name	Summary
MarkdownlintRuleDescription()

Properties

Name	Value	Summary
RuleId	int	Gets or sets the identifier of the rule.

Methods

Name	Value	Summary
get_Rule()	string	Inherited from BaseRuleDescription
set_Rule()		Inherited from BaseRuleDescription

Extension Methods

Name	Value	Summary
Dump<MarkdownlintRuleDescription>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<MarkdownlintRuleDescription>(MarkdownlintRuleDescription[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<MarkdownlintRuleDescription>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<MarkdownlintRuleDescription>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<MarkdownlintRuleDescription>(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<MarkdownlintRuleDescription>(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
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin