JsiiDocgen.Builder (io.github.cdklabs:projen 0.80.15 API)

java.lang.Object
- io.github.cdklabs.projen.cdk.JsiiDocgen.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<JsiiDocgen>

Enclosing class:: JsiiDocgen

@Stability(Experimental)
public static final class JsiiDocgen.Builder
extends Object
implements software.amazon.jsii.Builder<JsiiDocgen>

(experimental) A fluent builder for JsiiDocgen.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`JsiiDocgen`	`build()`
`static JsiiDocgen.Builder`	`create(JsiiProject project)`
`JsiiDocgen.Builder`	`filePath(String filePath)`	(experimental) File path for generated docs.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
@Stability(Experimental)
public static JsiiDocgen.Builder create(JsiiProject project)
```
    Parameters:
    
    project - This parameter is required.
    
    Returns:
    
    a new instance of JsiiDocgen.Builder.
  - filePath
```
@Stability(Experimental)
public JsiiDocgen.Builder filePath(String filePath)
```
    (experimental) File path for generated docs.
    Default: "API.md"
    
    Parameters:
    
    filePath - File path for generated docs. This parameter is required.
    
    Returns:
    
    this
  - build
```
@Stability(Experimental)
public JsiiDocgen build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<JsiiDocgen>
    
    Returns:
    
    a newly built instance of JsiiDocgen.