RemoteApiDocUrlResolver Class

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

Definition

Provides abstract functionality to resolve URLs to external documentation sites for code elements in specific namespaces.
public abstract class RemoteApiDocUrlResolver : IRemoteApiDocUrlResolver
Inheritance
Implements
Inherited by

Remarks

The RemoteApiDocUrlResolver class serves as the foundation for linking to external documentation resources. It provides namespace pattern matching capabilities that allow selective URL resolution based on namespace hierarchies. This enables documentation systems to integrate with multiple external documentation sources, each responsible for different parts of the API surface.

Derived classes implement specific URL resolution strategies while inheriting the namespace filtering mechanism, creating a flexible and extensible external documentation linking system.

Constructors

RemoteApiDocUrlResolver(Uri)Initializes a new instance of the RemoteApiDocUrlResolver class.

Properties

NamespacePatternsGets the namespace patterns that determine which namespaces are covered by this URL resolver.
SiteUrlGets the base URL of the documentation site.

Methods

ResolveMemberUrl(IMember)Attempts to resolve the documentation URL for the specified member.
ResolveNamespaceUrl(string)Attempts to resolve the documentation URL for the specified namespace.
SupportsMember(IMember)Determines whether the specified member is covered by the namespace patterns of this URL resolver.
SupportsNamespace(string)Determines whether the specified namespace is covered by this URL resolver.
TryGetMemberUrl(IMember, out Uri)Attempts to retrieve the documentation URL for the specified member.
TryGetNamespaceUrl(string, out Uri)Attempts to retrieve the documentation URL for the specified namespace.

Extension Methods

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