DocumentationContext Constructor

Namespace

Assembly

Kampute.DocToolkit.dll

Definition

Initializes a new instance of the DocumentationContext class.

public DocumentationContext(
	IProgrammingLanguage language,
	IDocumentAddressProvider addressProvider,
	IXmlDocProvider contentProvider,
	IDocumentFormatter contentFormatter,
	IEnumerable<IAssembly> assemblies,
	IEnumerable<ITopic> topics,
	object metadata = null)

Parameters

language IProgrammingLanguage: The programming language of the codebase being documented.
addressProvider IDocumentAddressProvider: The provider responsible for resolving documentation URLs and file paths of elements.
contentProvider IXmlDocProvider: The provider responsible for finding documentation content of elements.
contentFormatter IDocumentFormatter: The object responsible for formatting the documentation content.
assemblies IEnumerable<IAssembly>: The assemblies that contain the types and members to document.
topics IEnumerable<ITopic>: The top-level topics to incorporate into the documentation, including their subtopics.
metadata object optional: Optional metadata to associate with the documentation context.

Exceptions

ArgumentNullException: Thrown when any of the parameters are null.
ArgumentException: Thrown when topics contains duplicate topic names.

Remarks

The created DocumentationContext instance takes ownership of the provided contentFormatter, contentProvider, addressProvider, and metadata objects. If any of these objects implement IDisposable, they will be disposed of when the DocumentationContext is disposed.