IRemoteApiDocUrlResolver Interface

Namespace
Kampute.DocToolkit.Routing
Assembly
  • Kampute.DocToolkit.dll

Definition

Defines a contract for resolving URLs to documentation of code elements that are hosted remotely.
public interface IRemoteApiDocUrlResolver : IApiDocUrlProvider
Extends
Implemented by

Remarks

This resolver is responsible for mapping code elements to their corresponding documentation URLs for external documentation sources.

Properties

SiteUrlGets the base URL of the documentation site.

Methods

SupportsNamespace(string)Determines whether the specified namespace is covered by this URL resolver.

Extension Methods

TryGetUrlByCodeReference(this IApiDocUrlProvider, string, out Uri)Attempts to retrieves the documentation URL for the specified code reference.