Package io.kestra.core.docs

Class DocumentationGenerator

java.lang.Object

io.kestra.core.docs.DocumentationGenerator

@Singleton
public class DocumentationGenerator
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentationGenerator.ClassPlugin
static class	DocumentationGenerator.SubGroup

Constructor Summary

Constructors

Constructor	Description
DocumentationGenerator()

Method Summary

Modifier and Type	Method	Description
List<Document>	generate(RegisteredPlugin registeredPlugin)
static <T> String	render(AbstractClassDocumentation<T> classInputDocumentation)
static <T> String	render(ClassPluginDocumentation<T> classPluginDocumentation)
static <T> String	render(String templateName, Map<String,Object> vars)

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentationGenerator

public DocumentationGenerator()

Method Details

generate

public List<Document> generate(RegisteredPlugin registeredPlugin)
                        throws Exception

Throws:

Exception

render

public static <T> String render(ClassPluginDocumentation<T> classPluginDocumentation)
                         throws IOException

Throws:

IOException

render

public static <T> String render(AbstractClassDocumentation<T> classInputDocumentation)
                         throws IOException

Throws:

IOException

render

public static <T> String render(String templateName,
 Map<String,Object> vars)
                         throws IOException

Throws:

IOException