org.ballerinalang.docgen.model

Class PackageDoc

java.lang.Object

org.ballerinalang.docgen.model.PackageDoc

public class PackageDoc
extends Object

Package documentation.

Field Summary

Fields

Modifier and Type	Field and Description
BLangPackage	bLangPackage
String	description

Constructor Summary

Constructors

Constructor and Description
PackageDoc(Path descriptionPath, BLangPackage bLangPackage) Constructor.

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

bLangPackage

public final BLangPackage bLangPackage

Constructor Detail

PackageDoc

public PackageDoc(Path descriptionPath,
                  BLangPackage bLangPackage)
           throws IOException

Constructor.

Parameters:

descriptionPath - description of the package.

bLangPackage - package object.

Throws:

IOException - on error.