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.MonoApiTools.

Summary

Tool settings for mono-api-html.

Assembly

Cake.MonoApiTools.dll

Namespace

Cake.MonoApiTools

Base Types

ToolSettings

graph BT Type-->Base0["ToolSettings"] Type["MonoApiHtmlToolSettings"] class Type type-node

Syntax

public class MonoApiHtmlToolSettings : ToolSettings

Constructors

Name	Summary
MonoApiHtmlToolSettings()

Properties

Name	Value	Summary
Colorize	bool	Gets or sets a value indicating whether the output should be colorized.
Ignore	string[]
IgnoreAdded	string[]
IgnoreChangedParameterNames	bool
IgnoreChangedPropertySetters	bool
IgnoreChangedVirtual	bool
IgnoreDuplicateXml	bool
IgnoreNew	string[]
IgnoreNonBreaking	bool
IgnoreRemoved	string[]
OutputFormat	MonoApiHtmlOutputFormat	Gets or sets a value indicating what the format of the output file should be.
Verbose	bool	Gets or sets a value indicating whether to log additional information.

Extension Methods

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

MonoApiHtmlToolSettings Class

Summary

Syntax

Constructors

Properties

Extension Methods