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.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.629Z")
 @Stability(value=Experimental)
public class JsiiDocgen
extends software.amazon.jsii.JsiiObject

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

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

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

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(value=Experimental)
public JsiiDocgen(@NotNull
                                                 JsiiProject project)

Parameters:

project - This parameter is required.