DocumentAddressProvider Class
- Namespace
- Kampute.DocToolkit.Routing
- Assembly
- Kampute.DocToolkit.dll
Definition
Provides URLs and file paths to the documentation of namespaces, types, and type members.
public class DocumentAddressProvider : IDocumentAddressProvider- Inheritance
- object
- DocumentAddressProvider
- Implements
Remarks
This class is responsible for providing the documentation URLs and file paths for code references, types, and members based on the given documentation strategy. It checks if the code element is part of the documented assemblies and retrieves the relative URL or file path accordingly. If the element is not part of the assemblies, it attempts to resolve the URL using the configured external documentation URL resolvers.
Constructors
| DocumentAddressProvider(IDocumentAddressingStrategy, IEnumerable<IAssembly>, Uri) | Initializes a new instance of the DocumentAddressProvider class with the specified addressing strategy. |
Properties
| ActiveScope | Gets the currently active URL context. |
| Assemblies | Gets the assemblies being documented. |
| ExternalReferences | Gets the collection of resolvers for finding documentation URLs of code elements in external documentation sources. |
| Granularity | Gets the page granularity used for organizing documentation content. |
| Strategy | Gets the strategy that determines how generated documentation pages should be addressed. |
Methods
| BeginScope(string, IDocumentModel) | Creates a scoped URL context for the specified document path and model. |
| Create<TStrategy>(IEnumerable<IAssembly>, Uri) | Creates a new instance of the DocumentAddressProvider class with the specified addressing strategy. |
| FindExternalProviderForMember(IMember) | Finds an external documentation URL resolver that supports the specified member. |
| FindExternalProviderForNamespace(string) | Finds an external documentation URL resolver that supports the specified namespace. |
| IsInternalMember(IMember) | Determines whether the specified member belongs to the assemblies being documented. |
| IsInternalNamespace(string) | Determines whether the specified namespace belongs to the assemblies being documented. |
| ToDocumentUrl(string) | Creates an absolute or document-relative URL from a site-relative URL string. |
| TryGetMemberFile(IMember, out string) | Attempts to retrieve the path of the documentation file for the specified member. |
| TryGetMemberUrl(IMember, out Uri) | Attempts to retrieve the documentation URL for the specified member. |
| TryGetNamespaceFile(string, out string) | Attempts to retrieves the path of the documentation file for the specified namespace. |
| TryGetNamespaceUrl(string, out Uri) | Attempts to retrieve the documentation URL 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. |