DocumentAddressProvider.Create Method

Namespace

Kampute.DocToolkit.Routing

Assembly

Kampute.DocToolkit.dll

Definition

Creates a new instance of the DocumentAddressProvider class with the specified addressing strategy.

public static DocumentAddressProvider Create<TStrategy>(IEnumerable<IAssembly> assemblies, Uri baseUrl = null)
	where TStrategy : IDocumentAddressingStrategy, new()

Type Parameters

TStrategy: The type of the addressing strategy to use.

Parameters

assemblies IEnumerable<IAssembly>: The assemblies being documented.
baseUrl Uri optional: The base URL of the documentation site, or null for relative URLs.

Returns

DocumentAddressProvider: A new instance of the DocumentAddressProvider class.

Exceptions

ArgumentNullException: Thrown when assemblies is null.
ArgumentException: Thrown when baseUrl is not null and is not an absolute URL.