Package org.wildfly.galleon.plugin.doc.generator

Class DocGenerator

java.lang.Object

org.wildfly.galleon.plugin.doc.generator.DocGenerator

public class DocGenerator
extends Object

Constructor Summary

Constructors

Constructor	Description
DocGenerator()

Method Summary

Modifier and Type	Method	Description
static void	generate(SimpleLog log, Path docZipArchive, Path outputDirectory, Path metadataPath, Path managementAPIPath, Path featuresPath, Path localRepositoryPath)	Generate documentation from the feature pack's metadata and model.
static boolean	generateModel(Path outputDirectory, Path managementAPIPath, Path featuresPath)	Generate the model reference in the outputDirectory

Methods inherited from class java.lang.Object

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

Constructor Details

DocGenerator

public DocGenerator()

Method Details

generateModel

public static boolean generateModel(Path outputDirectory,
 Path managementAPIPath,
 Path featuresPath)
                             throws IOException

Generate the model reference in the outputDirectory

Parameters:

outputDirectory - the root directory to generate the model reference

managementAPIPath - the path to the management-api.json file

featuresPath - the path to the features.json file

Returns:

true if the model is generated

Throws:

IOException

generate

public static void generate(SimpleLog log,
 Path docZipArchive,
 Path outputDirectory,
 Path metadataPath,
 Path managementAPIPath,
 Path featuresPath,
 Path localRepositoryPath)
                     throws IOException

Generate documentation from the feature pack's metadata and model. The documentation is generated in the outputDirectory. A zip archive that contains the generated documentation is created at docZipArchive

Throws:

IOException