Package io.fluxzero.tools.jsondoclet.core

Class DocGenerationTask

java.lang.Object

io.fluxzero.tools.jsondoclet.core.DocGenerationTask

public final class DocGenerationTask
extends Object

Coordinates traversal and writing of documentation artifacts.

Constructor Summary

Constructors

Constructor	Description
DocGenerationTask(DocletConfiguration configuration, DocletEnvironment environment, Reporter reporter)	Creates a new task bound to the supplied doclet execution context.

Method Summary

Modifier and Type	Method	Description
boolean	execute()	Executes the traversal of packages and types, writing JSON files and indexes.

Methods inherited from class java.lang.Object

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

Constructor Details

DocGenerationTask

public DocGenerationTask(DocletConfiguration configuration,
 DocletEnvironment environment,
 Reporter reporter)

Creates a new task bound to the supplied doclet execution context.

Method Details

execute

public boolean execute()

Executes the traversal of packages and types, writing JSON files and indexes.

Returns:

true when all data is written successfully; false otherwise