Sisk

Class

JsonRpcHtmlExport

Namespace
Sisk.JsonRPC.Documentation
Assembly
Sisk.JsonRPC.dll

Provides an HTML-based IJsonRpcDocumentationExporter.

C#
public class JsonRpcHtmlExport : IJsonRpcDocumentationExporter

Inheritance #

object ← JsonRpcHtmlExport

Implements #

IJsonRpcDocumentationExporter

Inherited Members #

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors #

NameDescription
JsonRpcHtmlExport()

Properties #

NameDescription
ExportMetadataGets or sets an boolean indicating if the documentation metadata should be exported in the HTML.
ExportSummaryGets or sets an boolean indicating if an summary should be exported in the HTML.
HeaderGets or sets an optional object to append to the header of the exported HTML.
StyleGets or sets the CSS styles used in the HTML export.

Methods #

NameDescription
EncodeDocumentationHtml(JsonRpcDocumentation)Encodes the specified JsonRpcDocumentation into a HTML string.
ExportDocumentBytes(JsonRpcDocumentation)Exports the JSON-RPC documentation to a byte array.

Type to search the documentation and the API reference.