DocumentationContextBuilder<TContext>.AddXmlDoc Method

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll

Definition

Adds an XML documentation file to the documentation.
public virtual DocumentationContextBuilder<TContext> AddXmlDoc(string xmlDocPath)

Parameters

xmlDocPath string
The path to the XML documentation file.

Returns

DocumentationContextBuilder<TContext>
The current builder instance for method chaining.

Exceptions

ArgumentException
Thrown when xmlDocPath is null or empty.
FileNotFoundException
Thrown when the XML documentation file cannot be found.