Summary

The MSBuild Xml documentation example code parser.

Namespace

Cake.Common.Solution.Project.XmlDoc

Base Types

graph BT Type-->Base0["object"] Type["XmlDocExampleCodeParser"] class Type type-node

Syntax

public sealed class XmlDocExampleCodeParser

Name	Summary
XmlDocExampleCodeParser(IFileSystem, IGlobber, ICakeLog)	Initializes a new instance of the `XmlDocExampleCodeParser` class.

Name	Value	Summary
Parse(FilePath)	IEnumerable<XmlDocExampleCode>	Parses Xml documentation example code from given path.
ParseFiles(GlobPattern)	IEnumerable<XmlDocExampleCode>	Parses Xml documentation example code from file(s) using given pattern.

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