IAssemblyDocumentation Interface
Provides the base requirements of an object that can access documentation for the types and members defined in an assembly.
public interface IAssemblyDocumentationMethods
GetDocumentation(ITypeDefinition)
Returns the IDocumentationProvider, if any, that is available for the specified ITypeDefinition.
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.
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.