IDocumentAddressProvider Interface
- Namespace
- Kampute.DocToolkit.Routing
- Assembly
- Kampute.DocToolkit.dll
Definition
Represents a contract for resolving the documentation URLs and files for code references, types, members, and topics.
public interface IDocumentAddressProvider : IApiDocUrlProvider, IDocumentUrlContextProvider- Extends
- Implemented by
Remarks
This provider unifies various addressing resolution capabilities in the documentation system, combining URL resolution, file resolution, and topic addressing. It serves as a central access point for all addressing concerns, simplifying integration with the rest of the documentation generation pipeline. By consolidating these responsibilities, it ensures consistent addressing behavior across the entire documentation system.
Properties
| Granularity | Gets the page granularity used for organizing documentation content. |
Methods
| TryGetMemberFile(IMember, out string) | Attempts to retrieve the path of the documentation file for the specified member. |
| TryGetNamespaceFile(string, out string) | Attempts to retrieves the path of the documentation file for the specified namespace. |
| TryGetTopicFile(ITopic, out string) | Attempts to retrieve the path of the file for the specified topic. |
| TryGetTopicUrl(ITopic, out Uri) | Attempts to retrieve the URL for the specified topic. |
Extension Methods
| TryGetUrlByCodeReference(this IApiDocUrlProvider, string, out Uri) | Attempts to retrieves the documentation URL for the specified code reference. |