Definition
Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core.TransformersSyntax
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 socref references can be resolved, and building Microsoft Learn URLs for framework types and C# keywords.
Derived classes implement XmlTransformerBase.ConvertXml to turn the XML tags into their own format, such as
Markdown or HTML, and call XmlTransformerBase.ResolveReference to turn a cref into a DocReference.
Constructors
.ctor Inherited
Inherited from
objectSyntax
Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
Returns
Type:bool
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?
TransformAsync
Transforms a documentation entity and all of its children by converting their XML documentation tags.Syntax
Parameters
Returns
Type:System.Threading.Tasks.Task
A task representing the asynchronous transformation operation.
Remarks
When entity is a DocAssembly, the reference map is rebuilt from it first, socref references resolve against the assembly being transformed.
Related APIs
- CloudNimble.DotNetDocs.Core.IDocTransformer