Package org.forgerock.api.markup

Class ApiDocGenerator

java.lang.Object

org.forgerock.api.markup.ApiDocGenerator

public final class ApiDocGenerator
extends Object

Generates static AsciiDoc documentation for CREST API Descriptors.

Method Summary

Modifier and Type	Method	Description
static void	execute(String title, ApiDescription apiDescription, Path inputDirPath, Path outputDirPath, ApiDescription... externalApiDescriptions)	Generates AsciiDoc documentation for a CREST API Descriptor, to an output-directory.
static String	execute(String title, ApiDescription apiDescription, Path inputDirPath, ApiDescription... externalApiDescriptions)	Generates AsciiDoc documentation for a CREST API Descriptor, to a String.

Methods inherited from class java.lang.Object

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

Method Detail

execute

public static void execute(String title,
                           ApiDescription apiDescription,
                           Path inputDirPath,
                           Path outputDirPath,
                           ApiDescription... externalApiDescriptions)

Generates AsciiDoc documentation for a CREST API Descriptor, to an output-directory.

Parameters:

title - API title

apiDescription - API Description

externalApiDescriptions - External CREST API Descriptions, for resolving References, or null

inputDirPath - Input directory or null if not overriding ADOC files

outputDirPath - Root output directory

execute

public static String execute(String title,
                             ApiDescription apiDescription,
                             Path inputDirPath,
                             ApiDescription... externalApiDescriptions)

Generates AsciiDoc documentation for a CREST API Descriptor, to a String.

Parameters:

title - API title

apiDescription - API Description

externalApiDescriptions - External CREST API Descriptions, for resolving References, or null

inputDirPath - Input directory or null if not overriding ADOC files

Returns:

Resulting AsciiDoc markup as a String