XmlDocProviderCache Class
- Namespace
- Kampute.DocToolkit.XmlDoc
- Assembly
- Kampute.DocToolkit.dll
Definition
A wrapper for IXmlDocProvider that adds caching support to improve performance for repeated queries.
public sealed class XmlDocProviderCache : IXmlDocProvider- Inheritance
- object
- XmlDocProviderCache
- Implements
Remarks
The XmlDocProviderCache wraps an existing IXmlDocProvider instance and caches the results of documentation queries. This can significantly improve performance when the same documentation is requested multiple times.
Thread Safety
All public members of the type are guaranteed to be thread-safe.
Constructors
| XmlDocProviderCache(IXmlDocProvider) | Initializes a new instance of the XmlDocProviderCache class. |
Properties
| HasDocumentation | Gets a value indicating whether the XML documentation provider has any documentation available. |
Methods
| TryGetDoc(string, out XmlDocEntry) | Attempts to retrieve the XML documentation for the specified code reference. |
Extension Methods
| InspectDocumentation(this IXmlDocProvider, IMember, XmlDocInspectionOptions) | Inspects the XML documentation for the specified member. |
| TryGetMemberDoc(this IXmlDocProvider, IMember, out XmlDocEntry) | Attempts to retrieves the XML documentation for the specified member. |
| TryGetNamespaceDoc(this IXmlDocProvider, string, out XmlDocEntry) | Attempts to retrieves the XML documentation for the specified namespace. |
| WithCaching(this IXmlDocProvider) | Wraps the specified IXmlDocProvider instance in a caching layer if it is not already cached. |