Class XmlDocumentationFile

Helper class for working with .NET XML documentation files.

Inheritance

Object

XmlDocumentationFile

Inherited Members

System.Object.ToString()

Object.Equals(Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

Object.MemberwiseClone()

Namespace: IRM.Xml

Assembly: IRM.dll

Syntax

public static class XmlDocumentationFile

Methods

MergeDocuments(String)

Merges one or more .NET XML documentation files to single xpath navigator model.

Declaration

public static XPathNavigator MergeDocuments(string documentDirectory)

Parameters

String documentDirectory The directory to pick up all xml files in.

Returns

System.Xml.XPath.XPathNavigator Returns a xpath navigator over the merged document.

Exceptions

System.ArgumentException Thrown if one or more file is not a .NET XML documentation file.

MergeDocuments(String[])

Merges one or more .NET XML documentation files to single xpath navigator model.

Declaration

public static XPathNavigator MergeDocuments(params string[] documentPaths)

Parameters

String[] documentPaths The xml files to merge.

Returns

System.Xml.XPath.XPathNavigator Returns a xpath navigator over the merged document.

Exceptions

System.ArgumentNullException Thrown if no document paths are passed in.

System.ArgumentException Thrown if one or more file is not a .NET XML documentation file.