XmlDocExampleCodeParser Class

Summary

The MSBuild Xml documentation example code parser.
Namespace
Cake.Common.Solution.Project.XmlDoc
Base Types
  • object
graph BT Type-->Base0["object"] Type["XmlDocExampleCodeParser"] class Type type-node

Syntax

public sealed class XmlDocExampleCodeParser

Constructors

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

Methods

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.

Extension Methods

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