Skip to main content

​
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.

​
.ctor Inherited

Inherited from object

​
Syntax

public Object()

​
Methods

​
Equals Inherited Virtual

Inherited from object

​
Syntax

public virtual bool Equals(object obj)

​
Parameters

NameTypeDescription
objobject?-

​
Returns

Type: bool

​
Equals Inherited

Inherited from object

​
Syntax

public static bool Equals(object objA, object objB)

​
Parameters

NameTypeDescription
objAobject?-
objBobject?-

​
Returns

Type: bool

​
GetHashCode Inherited Virtual

Inherited from object

​
Syntax

public virtual int GetHashCode()

​
Returns

Type: int

​
GetType Inherited

Inherited from object

​
Syntax

public System.Type GetType()

​
Returns

Type: System.Type

​
MemberwiseClone Inherited

Inherited from object

​
Syntax

protected internal object MemberwiseClone()

​
Returns

Type: object

​
ReferenceEquals Inherited

Inherited from object

​
Syntax

public static bool ReferenceEquals(object objA, object objB)

​
Parameters

NameTypeDescription
objAobject?-
objBobject?-

​
Returns

Type: bool

​
ToString Inherited Virtual

Inherited from object

​
Syntax

public virtual string ToString()

​
Returns

Type: string?

​
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