IApiDocUrlProvider Interface
- Namespace
- Kampute.DocToolkit.Routing
- Assembly
- Kampute.DocToolkit.dll
Definition
Defines a contract for resolving URLs to documentation of code elements.
public interface IApiDocUrlProvider- Implemented by
Remarks
This resolver is responsible for mapping code elements to their corresponding documentation URLs, which is essential for creating hyperlinked references between code and documentation. It enables the documentation system to link to both internal and external documentation sources, enhancing the connectivity and navigability of the generated documentation. Implementations may use various strategies including pattern-based lookups, remote APIs, or search services.
Methods
| 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. |