> ## Documentation Index
> Fetch the complete documentation index at: https://dotnetdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XmlTransformerBase

> Provides the format-neutral foundation for transformers that convert XML documentation comments into an output format.

## Definition

**Assembly:** CloudNimble.DotNetDocs.Core.dll

**Namespace:** CloudNimble.DotNetDocs.Core.Transformers

## Syntax

```csharp theme={"dark"}
CloudNimble.DotNetDocs.Core.Transformers.XmlTransformerBase
```

## Summary

Provides the format-neutral foundation for transformers that convert XML documentation comments into an output format.

## Remarks

This class owns everything that does not depend on the output format: walking the documentation model, deciding which
strings contain XML documentation tags, normalizing the indentation inherited from the XML documentation file, indexing
every entity so `cref` references can be resolved, and building Microsoft Learn URLs for framework types and C# keywords.

Derived classes implement [XmlTransformerBase.ConvertXml](https://dotnetdocs.com/api-reference/CloudNimble/DotNetDocs/Core/Transformers/MarkdownXmlTransformer.md#convertxml) to turn the XML tags into their own format, such as
Markdown or HTML, and call [XmlTransformerBase.ResolveReference](https://dotnetdocs.com/api-reference/CloudNimble/DotNetDocs/Core/Transformers/MarkdownXmlTransformer.md#resolvereference) to turn a `cref` into a [DocReference](https://dotnetdocs.com/api-reference/CloudNimble/DotNetDocs/Core/DocReference.md).

## Constructors

### &#x20;.ctor Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public Object()
```

## Methods

### &#x20;Equals Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual bool Equals(object obj)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `obj` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;Equals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public static bool Equals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;GetHashCode Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

### &#x20;GetType Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public System.Type GetType()
```

#### Returns

Type: `System.Type`

### &#x20;MemberwiseClone Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
protected internal object MemberwiseClone()
```

#### Returns

Type: `object`

### &#x20;ReferenceEquals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public static bool ReferenceEquals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;ToString Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual string ToString()
```

#### Returns

Type: `string?`

### &#x20;TransformAsync

Transforms a documentation entity and all of its children by converting their XML documentation tags.

#### Syntax

```csharp theme={"dark"}
public System.Threading.Tasks.Task TransformAsync(CloudNimble.DotNetDocs.Core.DocEntity entity)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `entity` | `CloudNimble.DotNetDocs.Core.DocEntity` | The documentation entity to transform. |

#### Returns

Type: `System.Threading.Tasks.Task`
A task representing the asynchronous transformation operation.

#### Remarks

When *entity* is a [DocAssembly](https://dotnetdocs.com/api-reference/CloudNimble/DotNetDocs/Core/DocAssembly.md), the reference map is rebuilt from it first, so
`cref` references resolve against the assembly being transformed.

## Related APIs

* CloudNimble.DotNetDocs.Core.IDocTransformer


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.