StreamAssemblyDocumentationBase Class
Provides an abstract base class for a System.IO.Stream-based assembly documentation source.
public abstract class StreamAssemblyDocumentationBase : IAssemblyDocumentation
- Inheritance:
- System.Object Object
- Derived:
- FileAssemblyDocumentation
- Implements:
- IAssemblyDocumentation
Constructors
StreamAssemblyDocumentationBase()
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
- IDocumentationProvider:
The IDocumentationProvider, if any, that is available for the specified ITypeDefinition.
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
- IDocumentationProvider:
The IDocumentationProvider, if any, that is available for the specified ITypeMemberDefinition.
GetStream()
Returns the System.IO.Stream to use for reading documentation.
protected abstract Stream GetStream()
Returns
- System.IO.Stream:
The System.IO.Stream to use for reading documentation.
Remarks
The System.IO.Stream must support seeking.
Refresh()
Clears all index and cache data, allowing the documentation to refresh itself on the next request.
public void Refresh()
Inherited Members
- System.Object.ToString()
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object, System.Object)
- System.Object.ReferenceEquals(System.Object, System.Object)
- System.Object.GetHashCode()
- System.Object.GetType()
- System.Object.MemberwiseClone()