XmlDocContextAwareReferenceResolver Class
- Namespace
- Kampute.DocToolkit.XmlDoc
- Assembly
- Kampute.DocToolkit.dll
Definition
Resolves XML documentation references using the current documentation context.
public class XmlDocContextAwareReferenceResolver : IXmlDocReferenceResolver- Inheritance
- object
- XmlDocContextAwareReferenceResolver
- Implements
Remarks
The XmlDocContextAwareReferenceResolver provides a context-aware implementation of the IXmlDocReferenceResolver interface. It uses information from a documentation context to resolve references to types, members, and language keywords within XML documentation comments.
Constructors
| XmlDocContextAwareReferenceResolver(IDocumentationContext) | Initializes a new instance of the XmlDocContextAwareReferenceResolver class. |
Properties
| Context | Gets the documentation context used for resolving references. |
Methods
| FormatCode(string) | Formats the specified code block for display in a documentation page. |
| GetCodeReferenceTitle(string) | Retrieves the title for a code reference based on the current language context. |
| GetCodeReferenceUrl(string) | Resolves the documentation URL for the specified code reference. |
| GetKeywordUrl(string) | Resolves the official documentation URL for the specified language keyword based on the current language context. |
| GetLanguageId(string) | Retrieves the identifier for the programming language of the specified code block. |
| GetTopicTitle(string) | Gets the title for a topic reference. |
| GetTopicUrl(string) | Gets the URL of the documentation for a topic reference. |