StreamAssemblyDocumentationBase Class
Provides an abstract base class for a Stream-based assembly documentation source.
public abstract class StreamAssemblyDocumentationBase : IAssemblyDocumentation- Inheritance:
- object object
- Derived:
- FileAssemblyDocumentation
- Implements:
- IAssemblyDocumentation
Constructors
StreamAssemblyDocumentationBase()
Initializes an instance of the class.
protected StreamAssemblyDocumentationBase()Methods
GetDocumentation(ITypeDefinition)
Returns the IDocumentationProvider, if any, that is available for the specified ITypeDefinition.
public IDocumentationProvider? GetDocumentation(ITypeDefinition typeDef)| Parameter | Type | Description |
|---|---|---|
| typeDef | ITypeDefinition | The ITypeDefinition for which to search. |
Returns
GetDocumentation(ITypeMemberDefinition)
Returns the IDocumentationProvider, if any, that is available for the specified ITypeMemberDefinition.
public IDocumentationProvider? GetDocumentation(ITypeMemberDefinition typeMemberDef)| Parameter | Type | Description |
|---|---|---|
| typeMemberDef | ITypeMemberDefinition | The ITypeMemberDefinition for which to search. |
Returns
GetStream()
Returns the Stream to use for reading documentation.
Refresh()
Clears all index and cache data, allowing the documentation to refresh itself on the next request.
public void Refresh()Inherited Members
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()