Class XmlDocumentationGenerator

Namespace

Refitter.Core

Assembly

Refitter.Core.dll

Generator class for creating XML documentation.

public class XmlDocumentationGenerator

Inheritance

object

XmlDocumentationGenerator

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

AppendInterfaceDocumentationByEndpoint(OpenApiOperation, StringBuilder)

Generates an interface description from the summary of the given endpoint and appends it to the builder.

public void AppendInterfaceDocumentationByEndpoint(OpenApiOperation endpoint, StringBuilder code)

Parameters

endpoint OpenApiOperation

The OpenAPI definition of the endpoint.

code StringBuilder

The builder to append the documentation to.

AppendInterfaceDocumentationByTag(OpenApiDocument, string, StringBuilder)

Generates an interface description from the tags of the given OpenAPI document and appends it to the builder.

public void AppendInterfaceDocumentationByTag(OpenApiDocument document, string tag, StringBuilder code)

Parameters

document OpenApiDocument

The parent document of the controller.

tag string

The controller tag that the endpoints were grouped by.

code StringBuilder

The builder to append the documentation to.

AppendMethodDocumentation(CSharpOperationModel, IReadOnlyList<string>, bool, StringBuilder, string?)

Appends XML docs for the given method to the given code builder.

public void AppendMethodDocumentation(CSharpOperationModel method, IReadOnlyList<string> parameters, bool hasApiResponse, StringBuilder code, string? dynamicQuerystringParameterType = null)

Parameters

method CSharpOperationModel

The NSwag model of the method's OpenAPI definition.

parameters IReadOnlyList<string>

The parameters the method is emitted with. The param tags are written for exactly these, so they always match the signature.

hasApiResponse bool

Indicates whether the method returns an ApiResponse.

code StringBuilder

The builder to append the documentation to.

dynamicQuerystringParameterType string

The type of the dynamic querystring wrapper parameter, when the method may have one.

AppendSingleInterfaceDocumentation(OpenApiDocument, StringBuilder)

Generates an interface description from the title of the given document and appends it to the builder.

public void AppendSingleInterfaceDocumentation(OpenApiDocument document, StringBuilder code)

Parameters

document OpenApiDocument

The OpenAPI definition of the document.

code StringBuilder

The builder to append the documentation to.