org.ballerinalang.docgen

Class Generator

java.lang.Object

org.ballerinalang.docgen.Generator

public class Generator
extends Object

Generates the Page objects for bal packages.

Constructor Summary

Constructors

Constructor and Description
Generator()

Method Summary

Modifier and Type	Method and Description
static ActionDoc	createDocForNode(BLangAction actionNode) Create documentation for actions.
static AnnotationDoc	createDocForNode(BLangAnnotation annotationNode) Create documentation for annotations.
static ConnectorDoc	createDocForNode(BLangConnector connectorNode) Create documentation for connectors.
static FunctionDoc	createDocForNode(BLangFunction functionNode) Create documentation for functions.
static StructDoc	createDocForNode(BLangStruct structNode) Create documentation for structs.
static GlobalVariableDoc	createDocForNode(BLangVariable bLangVariable) Create documentation for global variables.
static EnumDoc	createDocForNode(EnumNode enumNode) Create documentation for enums.
static Page	generatePage(BLangPackage balPackage, List<Link> packages) Generate the page when the bal package is passed.
static Page	generatePageForPrimitives(BLangPackage balPackage, List<Link> packages) Generate the page for primitive types.
static String	returnParamAnnotation(BLangNode node, int returnTypeIndex) Get description annotation of the return parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

Generator

public Generator()

Method Detail

generatePage

public static Page generatePage(BLangPackage balPackage,
                                List<Link> packages)

Generate the page when the bal package is passed.

Parameters:

balPackage - The current package that is being viewed.

packages - List of available packages.

Returns:

A page model for the current package.

generatePageForPrimitives

public static Page generatePageForPrimitives(BLangPackage balPackage,
                                             List<Link> packages)

Generate the page for primitive types.

Parameters:

balPackage - The ballerina.builtin package.

packages - List of available packages.

Returns:

A page model for the primitive types.

createDocForNode

public static EnumDoc createDocForNode(EnumNode enumNode)

Create documentation for enums.

Parameters:

enumNode - ballerina enum node.

Returns:

documentation for enum.

createDocForNode

public static AnnotationDoc createDocForNode(BLangAnnotation annotationNode)

Create documentation for annotations.

Parameters:

annotationNode - ballerina annotation node.

Returns:

documentation for annotation.

createDocForNode

public static GlobalVariableDoc createDocForNode(BLangVariable bLangVariable)

Create documentation for global variables.

Parameters:

bLangVariable - ballerina variable node.

Returns:

documentation for global variables.

createDocForNode

public static FunctionDoc createDocForNode(BLangFunction functionNode)

Create documentation for functions.

Parameters:

functionNode - ballerina function node.

Returns:

documentation for functions.

createDocForNode

public static ActionDoc createDocForNode(BLangAction actionNode)

Create documentation for actions.

Parameters:

actionNode - ballerina action node.

Returns:

documentation for actions.

createDocForNode

public static StructDoc createDocForNode(BLangStruct structNode)

Create documentation for structs.

Parameters:

structNode - ballerina struct node.

Returns:

documentation for structs.

createDocForNode

public static ConnectorDoc createDocForNode(BLangConnector connectorNode)

Create documentation for connectors.

Parameters:

connectorNode - ballerina connector node.

Returns:

documentation for connectors.

returnParamAnnotation

public static String returnParamAnnotation(BLangNode node,
                                           int returnTypeIndex)

Get description annotation of the return parameter.

Parameters:

node - parent node.

returnTypeIndex - The index of the return type.

Returns:

description of the return parameter.