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

AppendInterfaceDocumentation(OpenApiDocument, StringBuilder)

Appends XML docs for the given interface definition to the given code builder. This uses the OpenAPI document's info description as the summary.

public void AppendInterfaceDocumentation(OpenApiDocument document, StringBuilder code)

Parameters

document OpenApiDocument

The OpenAPI definition of the interface.

code StringBuilder

The builder to append the documentation to.

AppendInterfaceDocumentation(OpenApiOperation, StringBuilder)

Appends XML docs for the given interface definition to the given code builder. This uses the OpenAPI operation info to generate the summary and remarks.

public void AppendInterfaceDocumentation(OpenApiOperation group, StringBuilder code)

Parameters

group OpenApiOperation

The OpenAPI definition of the interface.

code StringBuilder

The builder to append the documentation to.

AppendMethodDocumentation(CSharpOperationModel, bool, bool, bool, StringBuilder)

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

public void AppendMethodDocumentation(CSharpOperationModel method, bool hasApiResponse, bool hasDynamicQuerystringParameter, bool hasApizrRequestOptionsParameter, StringBuilder code)

Parameters

method CSharpOperationModel

The NSwag model of the method's OpenAPI definition.

hasApiResponse bool

Indicates whether the method returns an ApiResponse.

hasDynamicQuerystringParameter bool

Indicates whether the method gets a dynamic querystring parameter

hasApizrRequestOptionsParameter bool

Indicates whether the method gets an IApizrRequestOptions options final parameter

code StringBuilder

The builder to append the documentation to.