Definition

Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core.Renderers Inheritance: CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Syntax

CloudNimble.DotNetDocs.Core.Renderers.JsonRenderer

Summary

Renders documentation as JSON files.

Remarks

Generates structured JSON documentation suitable for API consumption and integration with documentation tools.

Constructors

.ctor

Initializes a new instance of the JsonRenderer class.

Syntax

public JsonRenderer(CloudNimble.DotNetDocs.Core.ProjectContext context = null, CloudNimble.DotNetDocs.Core.Renderers.JsonRendererOptions options = null)

Parameters

NameTypeDescription
contextCloudNimble.DotNetDocs.Core.ProjectContext?The project context. If null, a default context is created.
optionsCloudNimble.DotNetDocs.Core.Renderers.JsonRendererOptions?The rendering options. If null, default options are used.

Methods

RenderAsync

Renders the documentation assembly to JSON files.

Syntax

public System.Threading.Tasks.Task RenderAsync(CloudNimble.DotNetDocs.Core.DocAssembly model)

Parameters

NameTypeDescription
modelCloudNimble.DotNetDocs.Core.DocAssemblyThe documentation assembly to render.

Returns

Type: System.Threading.Tasks.Task A task representing the asynchronous rendering operation.
  • CloudNimble.DotNetDocs.Core.IDocRenderer