Interface IXmlDocumentationService
Namespace: Momentum.Extensions.XmlDocs
Assembly: Momentum.Extensions.XmlDocs.dll
Defines a service for loading and retrieving XML documentation comments.
public interface IXmlDocumentationServiceMethods
ClearCache()
Clears all cached documentation.
void ClearCache()GetDocumentation(string)
Gets the documentation for a specific member by its XML documentation name.
XmlDocumentationInfo? GetDocumentation(string memberName)Parameters
memberName string
The XML documentation member name (e.g., "T:Namespace.Type").
Returns
The documentation information if found; otherwise, null.
GetMethodDocumentation(MethodInfo)
Gets the documentation for a method.
XmlDocumentationInfo? GetMethodDocumentation(MethodInfo methodInfo)Parameters
methodInfo MethodInfo
The method to get documentation for.
Returns
The documentation information if found; otherwise, null.
GetPropertyDocumentation(PropertyInfo)
Gets the documentation for a property.
XmlDocumentationInfo? GetPropertyDocumentation(PropertyInfo propertyInfo)Parameters
propertyInfo PropertyInfo
The property to get documentation for.
Returns
The documentation information if found; otherwise, null.
GetTypeDocumentation(Type)
Gets the documentation for a type.
XmlDocumentationInfo? GetTypeDocumentation(Type type)Parameters
type Type
The type to get documentation for.
Returns
The documentation information if found; otherwise, null.
LoadDocumentationAsync(string, CancellationToken)
Asynchronously loads XML documentation from the specified file.
Task<bool> LoadDocumentationAsync(string xmlFilePath, CancellationToken cancellationToken = default)Parameters
xmlFilePath string
The path to the XML documentation file.
cancellationToken CancellationToken
A token to cancel the asynchronous operation.
Returns
A task that represents the asynchronous operation. The task result contains true if the documentation was loaded successfully; otherwise, false.