IXmlDocReferenceResolver Interface

Namespace
Kampute.DocToolkit.XmlDoc
Assembly
  • Kampute.DocToolkit.dll

Definition

Provides methods for resolving context information related to XML documentation comments.
public interface IXmlDocReferenceResolver
Implemented by

Remarks

The IXmlDocReferenceResolver interface defines a contract for components that resolve references and context information within XML documentation. The resolvers provide context-specific information that enhances the documentation with proper links and formatting.

This interface is typically used by XML documentation transformers during the conversion process from XML documentation comments to output formats like HTML or Markdown.

Implementations of this interface are responsible for:
  • Resolving name and URL of code references to types and members
  • Resolving title and URL of topic references to documentation topics
  • Resolving official documentation URLs to language-specific keywords
  • Converting site-root-relative URLs to absolute or document-relative URLs
  • Formatting code blocks for display in documentation
  • Detecting and identifying programming languages for code snippets
Common implementations include XmlDocNullReferenceResolver which provides no-op implementations with no actual resolution, and XmlDocContextAwareReferenceResolver which uses the current documentation context to resolve references appropriately.

Methods

FormatCode(string)Formats the specified code block for display in a documentation page.
GetCodeReferenceTitle(string)Gets the title for a code reference.
GetCodeReferenceUrl(string)Gets the URL of the documentation for a code reference.
GetKeywordUrl(string)Gets the URL of the official documentation for a language-specific keyword.
GetLanguageId(string)Gets the identifier of the programming language used for signature highlighting of a code block.
GetTopicTitle(string)Gets the title for a topic reference.
GetTopicUrl(string)Gets the URL of the documentation for a topic reference.

See Also