DocumentationContextBuilder<TContext>.CreateAddressProvider Method

Namespace

Assembly

Kampute.DocToolkit.dll

Definition

Creates the document address provider based on the configured settings.

protected virtual IDocumentAddressProvider CreateAddressProvider(IEnumerable<IAssembly> assemblies)

Parameters

assemblies IEnumerable<IAssembly>: The assemblies to be documented.

Returns

IDocumentAddressProvider: An instance of IDocumentAddressProvider representing the document address provider.

Exceptions

ArgumentNullException: Thrown when assemblies is null.
InvalidOperationException: Thrown when the addressing strategy is not configured.

Remarks

This method initializes the document address provider with the specified addressing strategy and base URL. It also adds all configured external references to the provider. The type and type members that are not defined in the provided assemblies will be treated as external references.

If no reference to MicrosoftDocs is provided, it will add it by default to ensure that .NET API documentation links can be resolved.