Summary
Parses Xml documentation example code from file(s) using given pattern.
- Namespace
- Cake
.Common .Solution .Project .XmlDoc - Containing Type
- XmlDocAliases
Syntax
[CakeMethodAlias]
public static IEnumerable<XmlDocExampleCode> ParseXmlDocFilesExampleCode(this ICakeContext context, GlobPattern pattern)Examples
var filesExampleCodes = ParseXmlDocFilesExampleCode("./Cake.*.xml");
foreach(var exampleCode in filesExampleCodes)
{
Information(
"{0}\r\n{1}",
exampleCode.Name,
exampleCode.Code
);
}Attributes
| Type | Description |
|---|---|
| Cake |
An attribute used to mark script method aliases. |
Parameters
| Name | Type | Description |
|---|---|---|
| context | ICakeContext | The context. |
| pattern | GlobPattern | The globber file pattern. |
Return Value
| Type | Description |
|---|---|
| IEnumerable |
Parsed example code. |