Kampute.DocToolkit.Routing Namespace

Provides components for resolving references and generating URLs for documentation elements.

Remarks

This namespace contains utilities for resolving references between documentation elements and generating links. These components create URLs for documentation pages, cross-references between API elements, and maps between code references and their corresponding documentation locations.

Classes

AbsoluteUrlContextManager	Converts documentation-root-relative URLs to absolute URLs using a fixed documentation root URL.
AddressingOptions	Provides options for addressing and organizing documentation files.
AddressingStrategy	Represents a base class for defining strategies to organize and address documentation pages.
DocumentAddressProvider	Provides URLs and file paths to the documentation of namespaces, types, and type members.
DocumentUrlContext	Represents a disposable context that manages relative URL resolution within a document context.
DocumentUrlContextManager	Represents the base class for managing document-specific URL contexts for adjusting cross-document relative links.
DocumentationUrlTransformer	Resolves documentation references according to their URL scope and the current document context.
HtmlAddressingOptions	Provides options for HTML-based addressing and organizing documentation files.
HtmlAddressingStrategy	Provides an abstract base class for HTML-based addressing strategies that organize documentation files in a hierarchical structure.
MicrosoftDocs	Provides URLs to the Microsoft Docs documentation site for .NET code elements.
PathToUrlMapper	Provides a mapping between file references and their corresponding URLs.
RelativeUrlContextManager	Manages URL contexts that resolve documentation-root-relative URLs relative to the current document.
RemoteApiDocUrlResolver	Provides abstract functionality to resolve URLs to external documentation sites for code elements in specific namespaces.
RoutingExtensions	Provides extension methods to various types related to documentation URL resolution and addressing strategies.
SearchBasedApiDocUrlResolver	Resolves URLs to search engines or documentation repositories for code elements that lack structured documentation.
StrategyBasedApiDocUrlResolver	Resolves URLs to external documentation sites for code elements using a structured addressing strategy.
UrlReference	Represents a non-API URL that has been referenced in the documentation.
UrlReferenceCollector	Provides a URL transformer that records all URLs that are processed through it.

Structs

ResourceAddress

Represents a resource address with support for both URL and file path representations.

Interfaces

IApiDocUrlProvider	Defines a contract for resolving URLs to documentation of code elements.
IContextualAddressingStrategy	Represents an addressing strategy that requires documentation context information for initialization.
IDocumentAddressProvider	Represents a contract for resolving the documentation URLs and files for code references, types, members, and topics.
IDocumentAddressingStrategy	Specifies how documentation content is organized into addressable pages.
IDocumentUrlContextProvider	Defines a contract for establishing and managing document-specific URL contexts for adjusting cross-document relative links.
IRemoteApiDocUrlResolver	Defines a contract for resolving URLs to documentation of code elements that are hosted remotely.
IResourceAddress	Defines a contract to represent a resource address.
IUrlTransformer	Provides a mapping between references and their corresponding URLs.