Package io.github.cdklabs.projen.cdk

Interface JsiiDocgenOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

JsiiDocgenOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.963Z")
@Stability(Experimental)
public interface JsiiDocgenOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for JsiiDocgen.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	JsiiDocgenOptions.Builder	A builder for JsiiDocgenOptions
static class	JsiiDocgenOptions.Jsii$Proxy	An implementation for JsiiDocgenOptions

Method Summary

Modifier and Type	Method	Description
static JsiiDocgenOptions.Builder	builder()
default String	getFilePath()	(experimental) File path for generated docs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFilePath

@Stability(Experimental)
@Nullable
default String getFilePath()

(experimental) File path for generated docs.

Default: "API.md"

builder

@Stability(Experimental)
static JsiiDocgenOptions.Builder builder()

Returns:

a JsiiDocgenOptions.Builder of JsiiDocgenOptions