org.ballerinalang.docgen.model

Class Documentable

java.lang.Object

org.ballerinalang.docgen.model.Documentable

Direct Known Subclasses:

ActionDoc, AnnotationDoc, ConnectorDoc, EnumDoc, FunctionDoc, GlobalVariableDoc, PrimitiveTypeDoc, StructDoc

public abstract class Documentable
extends Object

Documentable node abstract class.

Field Summary

Fields

Modifier and Type	Field and Description
List<Documentable>	children
String	description
String	icon
String	name

Constructor Summary

Constructors

Constructor and Description
Documentable(String name, String icon, String description, List<Documentable> children)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

name

public final String name

icon

public final String icon

description

public final String description

children

public final List<Documentable> children

Constructor Detail

Documentable

public Documentable(String name,
                    String icon,
                    String description,
                    List<Documentable> children)

Parameters:

name - name of the node.

icon - icon of the node.

description - description of the node.

children - children of the node if any.