Definition
Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.CoreSyntax
Summary
Defines a handler for processing documentation references from other projects.Remarks
Implementations of this interface are responsible for copying files from referenced documentation projects, rewriting internal paths in content files, and relocating resources to appropriate locations in the collection project. This interface follows the same pattern as IDocEnricher, IDocTransformer, and IDocRenderer for format-specific documentation processing.Properties
DocumentationType Abstract
Gets the documentation type this handler supports.Syntax
Property Value
Type:CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType
The SupportedDocumentationType that this handler can process.
Methods
ProcessAsync Abstract
Processes a documentation reference by copying files, rewriting content paths, and relocating resources as appropriate for this documentation format.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
reference | CloudNimble.DotNetDocs.Core.DocumentationReference | The documentation reference to process. |
documentationRootPath | string | The root path of the collection documentation output. |
Returns
Type:System.Threading.Tasks.Task
A task representing the asynchronous processing operation.