Package io.github.cdklabs.projen.cdk

Class JsiiDocgen

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.cdk.JsiiDocgen

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.962Z")
@Stability(Experimental)
public class JsiiDocgen
extends software.amazon.jsii.JsiiObject

(experimental) Creates a markdown file based on the jsii manifest: - Adds a docgen script to package.json - Runs jsii-docgen after compilation - Enforces that markdown file is checked in.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsiiDocgen.Builder	(experimental) A fluent builder for JsiiDocgen.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
	JsiiDocgen(JsiiProject project)
	JsiiDocgen(JsiiProject project, JsiiDocgenOptions options)
protected	JsiiDocgen(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	JsiiDocgen(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

JsiiDocgen

protected JsiiDocgen(software.amazon.jsii.JsiiObjectRef objRef)

JsiiDocgen

protected JsiiDocgen(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

JsiiDocgen

@Stability(Experimental)
public JsiiDocgen(@NotNull
                  JsiiProject project,
                  @Nullable
                  JsiiDocgenOptions options)

Parameters:

project - This parameter is required.

options -

JsiiDocgen

@Stability(Experimental)
public JsiiDocgen(@NotNull
                  JsiiProject project)

Parameters:

project - This parameter is required.