​
Definition

Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core.Transformers Inheritance: System.Object

​
Syntax

CloudNimble.DotNetDocs.Core.Transformers.MarkdownXmlTransformer

​
Summary

Transforms XML documentation tags in DocEntity properties to Markdown format.

​
Remarks

This transformer processes all string properties in the DocEntity object graph, converting XML documentation tags to their Markdown equivalents. It uses performance-optimized regex patterns to skip strings without XML tags and builds cross-references in a single pass.

​
Constructors

​
.ctor

Initializes a new instance of the MarkdownXmlTransformer class.

​
Syntax

public MarkdownXmlTransformer(CloudNimble.DotNetDocs.Core.ProjectContext projectContext)

​
Parameters

NameTypeDescription
projectContextCloudNimble.DotNetDocs.Core.ProjectContextThe project context for configuration and file naming.

​
Methods

​
TransformAsync

Transforms a documentation entity by converting XML tags to Markdown.

​
Syntax

public System.Threading.Tasks.Task TransformAsync(CloudNimble.DotNetDocs.Core.DocEntity entity)

​
Parameters

NameTypeDescription
entityCloudNimble.DotNetDocs.Core.DocEntityThe documentation entity to transform.

​
Returns

Type: System.Threading.Tasks.Task A task representing the asynchronous transformation operation.
  • CloudNimble.DotNetDocs.Core.IDocTransformer