Definition
Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core.Renderers Inheritance: CloudNimble.DotNetDocs.Core.Renderers.RendererBaseSyntax
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
Parameters
Name | Type | Description |
---|---|---|
context | CloudNimble.DotNetDocs.Core.ProjectContext? | The project context. If null, a default context is created. |
options | CloudNimble.DotNetDocs.Core.Renderers.JsonRendererOptions? | The rendering options. If null, default options are used. |
Methods
RenderAsync
Renders the documentation assembly to JSON files.Syntax
Parameters
Name | Type | Description |
---|---|---|
model | CloudNimble.DotNetDocs.Core.DocAssembly | The documentation assembly to render. |
Returns
Type:System.Threading.Tasks.Task
A task representing the asynchronous rendering operation.
Related APIs
- CloudNimble.DotNetDocs.Core.IDocRenderer