org.ballerinalang.docgen.model

Class Page

java.lang.Object

org.ballerinalang.docgen.model.Page

public class Page
extends Object

Page created by traversing the bal package.

Field Summary

Fields

Modifier and Type	Field and Description
List<Documentable>	constructs
String	description
Caption	heading
List<Link>	links
List<Link>	primitives

Constructor Summary

Constructors

Constructor and Description
Page(Caption heading, ArrayList<Documentable> constructs, List<Link> links)
Page(String description, Caption heading, ArrayList<Documentable> constructs, List<Link> links, List<Link> primitives)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

description

public final String description

heading

public final Caption heading

constructs

public final List<Documentable> constructs

links

public final List<Link> links

primitives

public final List<Link> primitives

Constructor Detail

Page

public Page(Caption heading,
            ArrayList<Documentable> constructs,
            List<Link> links)

Parameters:

heading - name of the bal package.

constructs - constructs in the package.

links - links to the other packages.

Page

public Page(String description,
            Caption heading,
            ArrayList<Documentable> constructs,
            List<Link> links,
            List<Link> primitives)

Parameters:

description - description of the package.

heading - name of the bal package.

constructs - constructs in the package.

links - links to the other packages.

primitives - links to the primitives.