IDocumentAddressingStrategy Interface

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

Definition

Specifies how documentation content is organized into addressable pages.
public interface IDocumentAddressingStrategy
Implemented by

Remarks

The addressing strategy is a core component of the documentation system that defines how documentation resources are organized and accessed. It handles the translation between topics and code elements (namespaces, types, and members) and their corresponding documentation resource locations.

When generating documentation, the addressing strategy maintains consistent linking between topics by resolving the appropriate URLs for references based on the current configuration. This allows for flexible documentation organization while preserving the integrity of inter-topic references.

This enables features like navigation, linking between documentation pages, and integration with external reference systems without requiring manual updates to cross-references when documentation structure changes.

Properties

FileExtensionGets the file extension of the documentation files.
GranularityGets the page granularity used for organizing documentation content.

Methods

IsAddressable(IMember)Determines whether the specified member can be addressed by this strategy.
TryResolveMemberAddress(IMember, out IResourceAddress)Attempts to resolve the address of the documentation content for the specified member.
TryResolveNamespaceAddress(string, out IResourceAddress)Attempts to resolve the address of the documentation content for the specified namespace.
TryResolveTopicAddress(ITopic, out IResourceAddress)Attempts to resolve the address for the documentation content of the specified topic.

Extension Methods

TryResolveAddressByCodeReference(this IDocumentAddressingStrategy, string, out IResourceAddress)Attempts to resolve the address of the documentation content for the specified code reference.